List tasks

Returns a list of tasks. Tasks include scheduled backup and on-demand restore related tasks.

The following table describes the supported task types.

Task Type	Description
aws_ebs_volume_file_restore	A restore task for a file within an EBS volume.
aws_ebs_volume_backup_seeding	The initial backup task of an EBS Volume - future backups are incremental.
aws_ebs_volume_incremental_backup	A scheduled incremental backup task for an EBS volume.
aws_ebs_volume_backup_indexing	A post-processing task that indexes the contents of an EBS volume in preparation for file-level indexing and restores. The `aws_ebs_volume_backup_indexing` task cannot be aborted.
aws_ebs_volume_restore	A restore task for an EBS Volume.
microsoft365_mailbox_seeding	The initial backup task of a mailbox - future backups are incremental.
microsoft365_mailbox_backup	A scheduled incremental backup task for a mailbox.
microsoft365_inventory_sync	A task that synchronizes Clumio with the Microsoft 365 domain by gathering mailbox information and other data, such as usage and sizing statistics. The `microsoft365_inventory_sync` task cannot be aborted.
microsoft365_mail_restore	A restore task for a microsoft365 mailbox.

The following table describes the supported task statuses.

Task Status	Description
queued	A task that is waiting to begin. A task that is in queue can be aborted at any time.
in_progress	A task that is currently running. Once the task has successfully completed, the task status changes to `completed`. A task that is in progress can be aborted at any time.
completed	A task that has successfully completed.
failed	A task that has failed to complete.
aborting	A task that is in the process of aborting. Only tasks that are queued or in progress can be aborted. Once a task has successfully aborted, the task status changes to `aborted`.
aborted	A task that has fully aborted.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

filter string

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the operations that can be performed on the field:

Field	Filter Condition	Description
primary_entity.value	$contains	The name or value given to the entity affected by the task. For example, `?filter={"primary_entity.value":{"$contains":"ubuntu-bbp-medium-01"}}`
primary_entity.id	$contains	The unique ID given to the entity affected by the task. For example, `?filter={"primary_entity.id":{"eq":"c8011712-9e16-11eb-bb8f-0a06889d7896"}}`
created_timestamp	$lte, $gte	The timestamp value of when the task was started (cannot exceed the last 6 months) in RFC-3999 format. For example, `?filter={"created_timestamp":{"$lte": "2020-09-13T00:00:00Z"}}`
type	$in	The task type. Examples of task types include "ebs_indexing", and "file_restore". Refer to the Task Type table for a complete list of task types. For example, `?filter={"type":{"$in":["ebs_incremental_backup"]}}`
category	$in	The task category. Examples of task categories include "backup", "restore", and "management". For example, `?filter={"category":{"$in":["backup"]}}`
genre	$in	The task genre. Examples of task types include "operational" and "administrative". For example, `?filter={"genre":{"$in":["operational"]}}`
status	$in	The task status. Examples of task statuses include, "queued", "in_progress", and "completed". Refer to the Task Status table for a complete list of task statuses. For example, `?filter={"status":{"$in":["completed"]}}`
id	$in	The Clumio-assigned ID of the task. Multiple tasks can be specified. For example, `?filter={"id":{"in":["101","114"]}}`

For more information about filtering, refer to the Filtering section of this guide.

Responses

200
default

Success

application/api.clumio.tasks=v1+json

Schema
Example (from schema)

Schema

_embedded object

Embedded responses related to the resource.

items object[]

A collection of requested items.

_etag string

The ETag value.

_links object

category string

The task category. Examples of task types include "backup", "restore", "snapshot", and "system".

Category	Description
backup	Encompasses all modes of backups. This does not include in-account snapshots.
restore	Encompasses all modes of restores. This does not include restores of in-account snapshots.
snapshot	Encompasses all modes of in-account snapshots.
snapshot_restore	Encompasses all modes of snapshot restores.
system	Encompasses a variety of system-initiated tasks, such as `aws_rds_backup_target_setup` and `aws_ec2_instance_backup_indexing`.
report_generation	Encompasses task types which generate reports, such as `activity_report_file_download`.
management	Encompasses user-initiated tasks which manage Clumio resources, such as `organizational_unit_update` and `policy_update`.

created_timestamp string

The timestamp of when the task was created. Represented in RFC-3339 format.

end_timestamp string

The timestamp of when the task ended. If this task has not yet ended, then this field has a value of null. Represented in RFC-3339 format.

genre string

The task genre. A genre is a high-level collection of task categories.

Genre	Description
operational	Encompasses all `backup`, `restore`, `snapshot`, and `snapshot_restore` tasks.
administrative	Encompasses `management`, `system`, and `report_generation` tasks.

id string

The Clumio-assigned ID of the task.

is_abortable boolean

Determines whether or not this task can be aborted. A task can be aborted if its status is either "queued" or "in_progress". Tasks of certain types including "aws_ebs_volume_backup_indexing" cannot be aborted.

parent_entity object

primary_entity object

progress_percentage int64

The percentage progress of task completion. Measured as an integer value between 0 and 100.

start_timestamp string

The timestamp of when the task started. If this task has not started yet, then this field has a value of null. Represented in RFC-3339 format.

status string

The task status. Examples of task statuses include, "queued", "in_progress", and "completed". Refer to the Task Status table for a complete list of task statuses.

type The task type. Examples of task types include "vm_backup_seeding", "ebs_indexing", and "file_restore".

Refer to the Task Type table for a complete list of task types.

_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_last object
The HATEOAS link to the last page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_next object
The HATEOAS link to the next page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_prev object
The HATEOAS link to the previous page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
current_count int64
The number of items listed on the current page.
filter_applied string
The filter used in the request. The filter includes both manually-specified and system-generated filters.
limit int64
The maximum number of items displayed per page in the response.
start string
The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").
total_count int64
The total number of items, summed across all pages.
total_pages_count int64
The total number of pages of results.

{
  "_embedded": {
    "items": [
      {
        "_etag": "string",
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "read-organizational-unit": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "update-task": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "category": "string",
        "created_timestamp": "string",
        "end_timestamp": "string",
        "genre": "string",
        "id": "string",
        "is_abortable": true,
        "parent_entity": {
          "id": "string",
          "type": "string",
          "value": "string"
        },
        "primary_entity": {
          "id": "string",
          "type": "string",
          "value": "string"
        },
        "progress_percentage": 0,
        "start_timestamp": "string",
        "status": "string",
        "type": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "filter_applied": "string",
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /tasks

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

limit — query

start — query

filter — query

curl -L -X GET 'https://us-west-2.api.clumio.com/tasks' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/tasks' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/tasks' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/tasks' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/tasks' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/tasks' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/tasks' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

List tasks​

Authorization

Request

List tasks