Skip to main content

Delete deploys by filter

DELETE 

/api/v1/catalog/deploys

Filter and delete deploys by SHA hash, environment, or type. Note that at least one of the filters need to be set. If looking to delete all deployments for an entity, use the Delete all deploys for entity endpoint instead.

Request

Query Parameters

    environment string
    sha string
    type string

    Possible values: [DEPLOY, SCALE, ROLLBACK, RESTART]

Responses

Successfully deleted deployment

Schema
    deploys object[]required
  • Array [
  • customData object

    Arbitrary string-to-any map of custom data about the deploy event

    property name* object

    Arbitrary string-to-any map of custom data about the deploy event

    deployer object
    email string
    name string
    deployerEmail stringdeprecated

    Replaced with Deployer object

    deployerName stringdeprecated

    Replaced with Deployer object

    environment string
    sha string

    Optional commit SHA hash that this deploy corresponds to

    timestamp date-timerequired

    ISO8601 timestamp string in UTC

    title stringrequired

    Human readable title for the deploy. This is usually the commit message or PR title.

    type stringrequired

    Possible values: [DEPLOY, SCALE, ROLLBACK, RESTART]

    url string

    Optional URL associated with deployment

    uuid uuidrequired
  • ]
Loading...