Update Tasks
Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status.
Request
URI
POST
https://{api_host}/vmc/api/orgs/{org}/tasks/{task}
COPY
Path Parameters
string
org
Required
Organization identifier.
string
task
Required
Task identifier
Query Parameters
string
action
Optional
If = 'cancel', task will be canceled
Responses
200
OK
Returns
Task
of type(s)
application/json
This response body class contains all of the following:
InlineTask0
{
"updated": "string",
"user_id": "string",
"updated_by_user_id": "string",
"created": "string",
"version": 5,
"updated_by_user_name": "string",
"user_name": "string",
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"status": "string",
"localized_error_message": "string",
"resource_id": "string",
"parent_task_id": "string",
"task_version": "string",
"correlation_id": "string",
"start_resource_entity_version": 0,
"sub_status": "string",
"task_type": "string",
"start_time": "string",
"task_progress_phases": [
{
"id": "string",
"name": "string",
"progress_percent": 0
}
],
"error_message": "string",
"org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"end_resource_entity_version": 5,
"service_errors": [
{
"default_message": "string",
"original_service": "string",
"localized_message": "string",
"original_service_error_code": "string"
}
],
"org_type": "string",
"estimated_remaining_minutes": 4,
"params": {},
"progress_percent": 75,
"phase_in_progress": "string",
"resource_type": "string",
"end_time": "string"
}
400
Invalid action or bad argument
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
integer
status
Required
HTTP status code
string
path
Required
Originating request URI
boolean
retryable
Required
If true, client should retry operation
string
error_code
Required
unique error code
array of
string
error_messages
Required
localized error messages
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Cannot find the task with given identifier
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
integer
status
Required
HTTP status code
string
path
Required
Originating request URI
boolean
retryable
Required
If true, client should retry operation
string
error_code
Required
unique error code
array of
string
error_messages
Required
localized error messages
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' https://{api_host}/vmc/api/orgs/{org}/tasks/{task}