APaptible
Deployments

show deployment

Changed on

Returns the details of a specific deployment by ID.

get/deployments/{id}

Request

  • Base URL
    https://api.aptible.com
  • Auth
    API key in header Authorization

Path parameters

idinteger required

id

Query parameters

no_embedboolean

When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.

Headers

Prefer'no_sensitive_extras=true'

When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.

Response

successful

idinteger required
_typestring required
statusstring required
operation_idinteger required
app_idinteger required
configuration_idinteger required
image_idinteger required
source_idinteger required
setting_idinteger required
docker_imagestring required
docker_repository_urlstring required
git_repository_urlstring required
git_refstring required
git_commit_shastring required
git_commit_timestampstring dateTime required
git_commit_urlstring required
git_commit_messagestring required
created_atstring dateTime required
updated_atstring dateTime required
deleted_atstring dateTime required

Changes

  • 1dc1e5b8c6ebRevision changes
    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed

  • c53f9485170aRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the required property to the response with the status