List Deploys

GET 
/configuration-hub/deploys

This API gets a list of deploys for the current tenant.

Responses

200

List of existing deploys.

application/json

Schema

Schema

• Array [

jobId string

Unique id assigned to this job.

status string

Possible values: [NOT_STARTED, IN_PROGRESS, COMPLETE, CANCELLED, FAILED]

Status of the job.

type string

Possible values: [CONFIG_DEPLOY_DRAFT]

Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job.

message string

Message providing information about the outcome of the deploy process.

requesterName string

The name of the user that initiated the deploy process.

fileExists boolean

Default value: true

Whether or not a results file was created and stored for this deploy.

created date-time

The time the job was started.

modified date-time

The time of the last update to the job.

completed date-time

The time the job was completed.

draftId string

The id of the draft that was used for this deploy.

draftName string

The name of the draft that was used for this deploy.

cloudStorageStatus string

Possible values: [SYNCED, NOT_SYNCED, SYNC_FAILED]

Whether this deploy results file has been transferred to a customer storage location.

• ]

Example (from schema)

[
  {
    "jobId": "07659d7d-2cce-47c0-9e49-185787ee565a",
    "status": "COMPLETE",
    "type": "CONFIG_DEPLOY_DRAFT",
    "message": "Deploy creation message",
    "requesterName": "requester.name",
    "fileExists": true,
    "created": "2021-05-11T22:23:16Z",
    "modified": "2021-05-11T22:23:16Z",
    "completed": "2021-05-11T22:23:16Z",
    "draftId": "07659d7d-2cce-47c0-9e49-185787ee565a",
    "draftName": "Draft Name",
    "cloudStorageStatus": "SYNCED"
  }
]

Example

[
  {
    "jobId": "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b",
    "status": "COMPLETE",
    "type": "CONFIG_DEPLOY_DRAFT",
    "message": "Deploy outcome message",
    "requesterName": "requester.name",
    "fileExists": true,
    "created": "2023-08-29T01:54:37.069Z",
    "modified": "2024-07-15T16:53:45.925Z",
    "completed": "2023-08-29T01:54:41.924Z",
    "draftId": "925e34e3-fa7c-4e7a-9b9a-cf3b8b4b1068",
    "draftName": "Source draft name",
    "cloudStorageStatus": "SYNCED"
  },
  {
    "jobId": "bdbcaae6-5e2a-4ebd-9eb3-37b09ec7eea4",
    "status": "FAILED",
    "type": "CONFIG_DEPLOY_DRAFT",
    "message": "Deploy outcome message",
    "requesterName": "requester.name",
    "fileExists": true,
    "created": "2023-07-20T18:38:00.812Z",
    "modified": "2024-07-15T16:53:59.778Z",
    "completed": "2023-07-20T18:38:01.783Z",
    "draftId": "e04da89d-941f-41e8-83ab-dd185ef5e646",
    "draftName": "Source draft name",
    "cloudStorageStatus": "NOT_SYNCED"
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...