Update a task

Manages the specified task. Managing a task includes aborting a task that is in queue or in progress.

Path Parameters

task_id string required
Performs the operation on the task with the specified ID.

application/json

Request Body

status string required
Possible values: [aborting]
The task status. Set this parameter to aborting to abort a task that is in queue ("queued") or in progress ("in_progress"). Tasks with other statuses cannot be aborted.

Responses

200
default

Success

application/api.clumio.tasks=v1+json

Schema
Example (from schema)

Schema

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

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

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

{
  "_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"
}

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"
    }
  ]
}

PATCH /tasks/:task_id

Authorization

Request

Click Edit to configure Base URL

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

Bearer Token

task_id — path required

Body

{
  "status": "aborting"
}

curl -L -X PATCH 'https://us-west-2.api.clumio.com/tasks/:task_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "status": "aborting"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/tasks/:task_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "status": "aborting"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/tasks/:task_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "status": "aborting"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/tasks/:task_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "status": "aborting"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/tasks/:task_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "status": "aborting"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/tasks/:task_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "status": "aborting"
}'

curl -L -X PATCH 'https://us-west-2.api.clumio.com/tasks/:task_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.tasks=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "status": "aborting"
}'

Update a task​

Authorization

Request

Update a task