Documentation menu

Project Environment Configuration Revisions

3 operations.

List Environment configuration revisions

GET/api/v1/projects/{projectId}/environments/{environmentId}/configuration-revisions

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to List Environment configuration revisions.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to List Environment configuration revisions.

query

NameTypeRequiredDescription
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to List Environment configuration revisions.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to List Environment configuration revisions.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • revisions (required): array<object>
  • pagination (required): object
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Create an immutable Environment configuration revision

POST/api/v1/projects/{projectId}/environments/{environmentId}/configuration-revisions

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create an immutable Environment configuration revision.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Create an immutable Environment configuration revision.

Request body

required — Request body for: Create an immutable Environment configuration revision.

application/json

NameTypeRequiredDescription
expectedHeadRevisionIdone of 2 typesrequired
snapshotobjectrequired

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • id (required): string
  • environmentId (required): string
  • revision (required): integer
  • parentRevisionId (required): one of 2 types
  • snapshot (required): object
  • createdAt (required): string
  • createdBy (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
409Request conflicts with current state of the resource, including safe deployment conflict classifications.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object

Get an Environment configuration revision

GET/api/v1/projects/{projectId}/environments/{environmentId}/configuration-revisions/{configurationRevisionId}

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Get an Environment configuration revision.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Get an Environment configuration revision.
configurationRevisionIdstringrequiredIdentifies the immutable Environment configuration revision. Applies to Get an Environment configuration revision.

Responses

StatusDescriptionBody
200Response for status 200
application/json
object
  • id (required): string
  • environmentId (required): string
  • revision (required): integer
  • parentRevisionId (required): one of 2 types
  • snapshot (required): object
  • createdAt (required): string
  • createdBy (required): string
400The request is malformed or cannot be processed.
application/json
PublicApiError
  • error (required): object
401Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired
application/json
PublicApiError
  • error (required): object
403Access denied. The authenticated user does not have permission to perform this action.
application/json
PublicApiError
  • error (required): object
404Resource not found.
application/json
PublicApiError
  • error (required): object
422Request validation failed. Check the request body, query parameters, or path parameters.
application/json
PublicApiError
  • error (required): object
500The server could not complete the request.
application/json
PublicApiError
  • error (required): object