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

200

Successfully deleted deployment

*/*

Schema

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
deployerEmail string
deployerName string
environment string
sha string
Optional commit SHA hash that this deploy corresponds to
timestamp date-timerequired
ISO8601 timestamp string without time zone
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]
]

Example (from schema)

{
  "deploys": [
    {
      "customData": {},
      "deployerEmail": "string",
      "deployerName": "string",
      "environment": "string",
      "sha": "string",
      "timestamp": "2023-09-22T22:13:27.392Z",
      "title": "string",
      "type": "DEPLOY"
    }
  ]
}

400

Trying to delete deploys without any filters

application/json

Schema

Schema

details string
gatewayHttpStatus int32
httpStatus int32
message stringrequired
requestId string
type stringrequired

Possible values: [INTEGRATION_MISSING, INTEGRATION_UNREGISTERED, INTEGRATION_UNSUPPORTED, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_UNAVAILABLE, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

{
  "details": "string",
  "gatewayHttpStatus": 0,
  "httpStatus": 0,
  "message": "string",
  "requestId": "string",
  "type": "INTEGRATION_MISSING"
}

Loading...