Set a cancel-requested flag on a running attempt

Request

Security

ApiKeyAuth

Path

idinteger, (int64)required

attempt id

curl -i -X POST \
  'https://api-workflow.treasuredata.com/api/attempts/{id}/kill' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>'

Responses

return an attempt

Bodyapplication/json

cancelRequestedbooleanrequired

true if kill requested

createdAtstring, (date-time)required

created time

Example:"2023-08-18T06:52:33Z"

donebooleanrequired

true if the attempt finished

finishedAtstring, (date-time)

finished time

Example:"2023-08-18T06:52:33Z"

idstringrequired

attempt ID

Example:"123456"

indexinteger, (int32)required

index for multiple attempts

Example:1

paramsobjectrequired

passed parameters as JSON

poolIdstring

ID of the pool to which this attempt is assigned.

Example:"42"

projectobject(IdAndName)required

Name and ID

retryAttemptNamestringrequired

attempt name for retry

Example:"retry-12345"

sessionIdstringrequired

session ID

Example:"123456"

sessionTimestringrequired

session time

Example:"2022-12-31T23:59:00+00:00"

sessionUuidstring, (uuid)required

unique UUID of this session

Example:"2b91a014-076e-4c6d-8b51-f4f91089cab2"

statusstringrequired

The current status of the attempt.

Enum:"blocked""queued""running""canceling""success""error""killed"

Example:"running"

successbooleanrequired

true if the attempt finished successfully

workflowobject(NameOptionalId)required

Name and optional ID

Response

{
  "cancelRequested": true,
  "createdAt": "2023-08-18T06:52:33Z",
  "done": true,
  "finishedAt": "2023-08-18T06:52:33Z",
  "id": "123456",
  "index": 1,
  "params": {},
  "poolId": "42",
  "project": {
    "id": "123456",
    "name": "abcdefg"
  },
  "retryAttemptName": "retry-12345",
  "sessionId": "123456",
  "sessionTime": "2022-12-31T23:59:00+00:00",
  "sessionUuid": "2b91a014-076e-4c6d-8b51-f4f91089cab2",
  "status": "running",
  "success": true,
  "workflow": {
    "id": "123456",
    "name": "abcdefg"
  }
}