Sign in
latestOpenAPI 3.0.12026-08-10434791.3 KB

4eedf1838ef4

Attempt

Set a cancel-requested flag on a running attempt

post/api/attempts/{id}/kill

Path parameters

idinteger required

attempt id

Response

return an attempt

cancelRequestedboolean required

true if kill requested

createdAtstring date-time required

created time

doneboolean required

true if the attempt finished

finishedAtstring date-time

finished time

idstring required

attempt ID

indexinteger required

index for multiple attempts

paramsobject required

passed parameters as JSON

poolIdstring

ID of the pool to which this attempt is assigned.

retryAttemptNamestring required

attempt name for retry

sessionIdstring required

session ID

sessionTimestring required

session time

sessionUuidstring uuid required

unique UUID of this session

status'blocked' | 'queued' | 'running' | 'canceling' | 'success' | 'error' | 'killed' required

The current status of the attempt.

successboolean required

true if the attempt finished successfully

Example response

{
  "createdAt": "2023-08-18T06:52:33Z",
  "finishedAt": "2023-08-18T06:52:33Z",
  "id": "123456",
  "index": 1,
  "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",
  "workflow": {
    "id": "123456",
    "name": "abcdefg"
  }
}