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

application/json

Schema

Schema

deploys

object[]

required

Array [

customData

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

]

Example (from schema)

{
  "deploys": [
    {
      "customData": {},
      "deployer": {
        "email": "string",
        "name": "string"
      },
      "environment": "string",
      "sha": "string",
      "timestamp": "2024-07-29T15:51:28.071Z",
      "title": "string",
      "type": "DEPLOY",
      "url": "https://cortex.io",
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

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_GRAPHQL_ERROR, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_INTERNAL_ERROR, INTEGRATION_NOT_IMPLEMENTED, INTEGRATION_BAD_GATEWAY, INTEGRATION_UNAVAILABLE, INTEGRATION_GATEWAY_TIMEOUT, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, REQUEST_TIMEOUT, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

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

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

Response Headers

• Retry-After

  integer

  The number of seconds until the rate limiting resets.

application/problem+json

Schema

Schema

detail string
instance uri-reference
retryAfter int32

The number of seconds until the rate limiting resets.

status int32required

Possible values: >= 100 and <= 599, [429]

title stringrequired
type uri-referencerequired

Example (from schema)

{
  "detail": "string",
  "instance": "string",
  "retryAfter": 0,
  "status": 429,
  "title": "string",
  "type": "string"
}

Loading...