Skip to main content

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 TypeDescription
aws_ebs_volume_file_restoreA restore task for a file within an EBS volume.
aws_ebs_volume_backup_seedingThe initial backup task of an EBS Volume - future backups are incremental.
aws_ebs_volume_incremental_backupA scheduled incremental backup task for an EBS volume.
aws_ebs_volume_backup_indexingA 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_restoreA restore task for an EBS Volume.
microsoft365_mailbox_seedingThe initial backup task of a mailbox - future backups are incremental.
microsoft365_mailbox_backupA scheduled incremental backup task for a mailbox.
microsoft365_inventory_syncA 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_restoreA restore task for a microsoft365 mailbox.
The following table describes the supported task statuses.
Task StatusDescription
queuedA task that is waiting to begin. A task that is in queue can be aborted at any time.
in_progressA 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.
completedA task that has successfully completed.
failedA task that has failed to complete.
abortingA 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`.
abortedA 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:

    FieldFilter ConditionDescription
    primary_entity.value$containsThe 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$containsThe 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, $gteThe 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$inThe 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$inThe task category. Examples of task categories include "backup", "restore", and "management". For example, ?filter={"category":{"$in":["backup"]}}
    genre$inThe task genre. Examples of task types include "operational" and "administrative". For example, ?filter={"genre":{"$in":["operational"]}}
    status$inThe 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$inThe 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

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • items object[]

    A collection of requested items.

  • _etag string

    The ETag value.

  • _links object

    URLs to pages related to the resource.

  • _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.

  • read-organizational-unit object

    A resource-specific HATEOAS link.

  • 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.

  • update-task object

    A resource-specific HATEOAS link.

  • 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.

  • category string

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

    CategoryDescription
    backupEncompasses all modes of backups. This does not include in-account snapshots.
    restoreEncompasses all modes of restores. This does not include restores of in-account snapshots.
    snapshotEncompasses all modes of in-account snapshots.
    snapshot_restoreEncompasses all modes of snapshot restores.
    systemEncompasses a variety of system-initiated tasks, such as aws_rds_backup_target_setup and aws_ec2_instance_backup_indexing.
    report_generationEncompasses task types which generate reports, such as activity_report_file_download.
    managementEncompasses 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.

    GenreDescription
    operationalEncompasses all backup, restore, snapshot, and snapshot_restore tasks.
    administrativeEncompasses 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

    The parent entity associated with the task.

  • id string

    A system-generated ID assigned to this entity.

  • type string

    Type is mostly an asset type or the type of Entity. Some examples are "restored_file", "aws_ebs_volume", etc.

  • value string

    A system-generated value assigned to the entity. For example, if the primary entity type is "aws_ebs_volume", then the value is the name of the EBS.

  • primary_entity object

    The primary entity associated with the task.

  • id string

    A system-generated ID assigned to this entity.

  • type string

    Type is mostly an asset type or the type of Entity. Some examples are "restored_file", "aws_ebs_volume", etc.

  • value string

    A system-generated value assigned to the entity. For example, if the primary entity type is "aws_ebs_volume", then the value is the name of the EBS.

  • 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.

Loading...