List deployments for entity

GET 
/api/v1/catalog/:tagOrId/deploys

List deployments for entity

Request

Path Parameters

tagOrId stringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query Parameters

pageSize int32required

Default value: 250

Number of results to return per page, between 1 and 1000. Default 250.

page int32required

Default value: 0

Page number to return, 0-indexed. Default 0.

Responses

200

Successfully retrieved deployments

application/json

Schema

Schema

deployments

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

]

page int32required

Current page number, 0-indexed

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "deployments": [
    {
      "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"
    }
  ],
  "page": 0,
  "total": 0,
  "totalPages": 0
}

404

Entity not found

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...