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
Possible values: [DEPLOY
, SCALE
, ROLLBACK
, RESTART
]
Responses
- 200
- 400
Successfully deleted deployment
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
deploys
object[]
required
customData
object
Arbitrary string-to-any map of custom data about the deploy event
Arbitrary string-to-any map of custom data about the deploy event
deployer
object
Replaced with Deployer object
Replaced with Deployer object
Optional commit SHA hash that this deploy corresponds to
ISO8601 timestamp string in UTC
Human readable title for the deploy. This is usually the commit message or PR title.
Possible values: [DEPLOY
, SCALE
, ROLLBACK
, RESTART
]
Optional URL associated with deployment
{
"deploys": [
{
"customData": {},
"deployer": {
"email": "string",
"name": "string"
},
"environment": "string",
"sha": "string",
"timestamp": "2024-09-13T14:30:58.959Z",
"title": "string",
"type": "DEPLOY",
"url": "https://cortex.io",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
Trying to delete deploys without any filters
- application/json
- Schema
- Example (from schema)
Schema
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
]
{
"details": "string",
"gatewayHttpStatus": 0,
"httpStatus": 0,
"message": "string",
"requestId": "string",
"type": "INTEGRATION_MISSING"
}