Update Task by Name

PUT/tasks/name/{task_name}

Update mutable fields for a task by its unique Name.

Path ParametersExpand Collapse

task_name: string

Body ParametersJSONExpand Collapse

merge_params: optional map[unknown]

task_metadata: optional map[unknown]

ReturnsExpand Collapse

Task object { id, cleaned_at, created_at, 6 more }

id: string

cleaned_at: optional string

created_at: optional string

name: optional string

params: optional map[unknown]

status: optional "CANCELED" or "COMPLETED" or "FAILED" or 5 more

One of the following:

"CANCELED"

"COMPLETED"

"FAILED"

"RUNNING"

"INTERRUPTED"

"TERMINATED"

"TIMED_OUT"

"DELETED"

status_reason: optional string

task_metadata: optional map[unknown]

updated_at: optional string

Update Task by Name

curl http://localhost:5003/tasks/name/$TASK_NAME \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{}'

{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "id",
  "cleaned_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "params": {
    "foo": "bar"
  },
  "status": "CANCELED",
  "status_reason": "status_reason",
  "task_metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}