APaptible
Operations

show operation

Changed on

Returns the details of a specific operation by ID.

get/operations/{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
typestring required
statusstring required
cancelledboolean required
abortedboolean required
git_refstring required
docker_refstring required
deploy_image_idinteger
envobject
container_sizeinteger required
container_countinteger required
disk_sizeinteger required
commandstring required
handlestring required
created_atstring dateTime required
updated_atstring dateTime required
certificatestring required
private_keystring
user_namestring required
user_emailstring required
destination_regionstring required
interactiveboolean required
instance_profilestring required
mount_pointstring required
dailyinteger required
monthlyinteger required
yearlyinteger required
pitr_daysinteger required
make_copyboolean required
keep_finalboolean required
enable_backupsboolean required
enable_pitrboolean required
settingsobject required
sensitive_settingsobject

Changes

  • ba72edfe0324Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc1e5b8c6ebRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the new optional header request parameter Prefer

    • info

      added the new optional query request parameter no_embed