{
  "id": "manage-tasks",
  "title": "Manage API tasks",
  "url": "https://redis.io/docs/latest/operate/rc/api/get-started/manage-tasks/",
  "summary": "A task is an API operation that is performed asynchronously because it exceeds the time allowed for the synchronous request/response model.",
  "tags": [
    "docs",
    "operate",
    "rc"
  ],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "page_type": "content",
  "content_hash": "2e8882975084f7dd0bcb602b29b6c94a13506d292d43c4bf4b150e4b4807015a",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Examples of API operations that use tasks are:\n\n- create subscription\n- create database\n- update database\n- delete database\n\nAll create, update, and delete API operations (`POST`, `PUT`, and `DELETE`) and some query operations (`GET`) use tasks.\n\nAfter you request an asynchronous operation, the operation returns a `taskId` that identities the specific task, and contains contextual and status data on the API operation performed by the task.\n\nTasks are part of the API [processing and provisioning lifecycle]()."
    },
    {
      "id": "task-information",
      "title": "Task information",
      "role": "content",
      "text": "When you request an asynchronous operation, the response to the request includes the task status and additional information about the task:\n\n[code example]\n\nWhere:\n\n- `taskId` - The unique identifier (UUID) of the specific task\n- `commandType` - The request (command) type\n- `status` - The [status]() of the task\n- `description` - A description of the status\n- `timestamp` - The time of the response in ISO-8601 date format and in the UTC timezone\n- `_links` - URI links to resources related to the task including:\n    - A link to itself\n    - Additional links based on the context of the response"
    },
    {
      "id": "task-status-updates",
      "title": "Task status updates",
      "role": "content",
      "text": "With the task ID, you can query the task status for updates and progress information.\nThe response in the above example shows a URL with the title `getTaskStatusUpdates`.\nThe URL in the `href` property returns updates for the specified task.\n\nUse [`GET /v1/tasks/{taskId}`]() to check the task status.\n\nThis endpoint returns information about the queried task.\n\n[code example]\n\nThis response example shows:\n\n- The `status` value is `\"processing-completed\"`.\n- The `response` field contains the resource identifier of the subscription resource changed by this task.\n- The `links` array contains another `getSubscriptionInformation` URL that links to the newly created subscription.\n    This link queries the subscription status during [provisioning]())"
    },
    {
      "id": "tasks-list",
      "title": "Tasks list",
      "role": "content",
      "text": "You can use the API operation [`GET /tasks`]() to list the recently submitted and completed tasks for the current account.\n\nThis API operation returns a list of tasks for the current account, sorted by most recent status update.\n\nThe result returns all the tasks submitted during the past 10 days."
    }
  ],
  "examples": [
    {
      "id": "task-information-ex0",
      "language": "json",
      "code": "{\n  \"taskId\": \"f3ec0e7b-0548-46e3-82f3-1977012ec738\",\n  \"commandType\": \"subscriptionCreateRequest\",\n  \"status\": \"received\",\n  \"description\": \"Task request received and is being queued for processing.\",\n  \"timestamp\": \"2019-08-08T09:07:39.826Z\",\n  \"_links\": {\n    \"task\": {\n      \"href\": \"https://api.redislabs.com/v1/tasks/f3ec0e7b-0548-46e3-82f3-1977012ec738\",\n      \"title\": \"getTaskStatusUpdates\",\n      \"type\": \"GET\"\n    }\n  }\n}",
      "section_id": "task-information"
    },
    {
      "id": "task-status-updates-ex0",
      "language": "json",
      "code": "{\n  \"taskId\": \"36d4b04d-72d4-4404-8600-a223120a553e\",\n  \"commandType\": \"subscriptionCreateRequest\",\n  \"status\": \"processing-completed\",\n  \"description\": \"Request processing completed successfully and its resources are now being provisioned / de-provisioned.\",\n  \"timestamp\": \"2019-08-08T06:49:15.929Z\",\n  \"response\": {\n    \"resourceId\": 77899\n  },\n  \"_links\": {\n    \"resource\": {\n      \"href\": \"https://api.redislabs.com/v1/subscriptions/77899\",\n      \"title\": \"getSubscriptionInformation\",\n      \"type\": \"GET\"\n    },\n    \"self\": {\n      \"href\": \"https://api.redislabs.com/v1/tasks/36d4b04d-72d4-4404-8600-a223120a553e\",\n      \"type\": \"GET\"\n    }\n  }\n}",
      "section_id": "task-status-updates"
    }
  ]
}