Orchestration - Plays

Update play

Update a play

put/orchestration/plays/{uuid}

Request

  • Base URL
    https://api.getcargo.io/v1
  • URL
    https://api.getcargo.io/v1/orchestration/plays/{uuid}
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

Play identifier.

Request body

namestring

Play name.

descriptionstring nullable

Play description.

isEnabledboolean

Whether the play is enabled.

limitnumber nullable

Maximum number of records.

trackingColumnSlugsstring[] nullable

Tracking column identifiers.

changeKindsstring[]

Change kinds to include.

runCreationRule'always' | 'once' | 'noConcurrency'

Run creation rule.

healthThresholdnumber

Health threshold for alerts.

folderUuidstring uuid nullable

Folder identifier.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.