Operations

create operation

Changed on Oct 20, 2026

Creates a new operation for the specified ephemeral session.

post/ephemeral_sessions/{ephemeral_session_id}/operations

Request

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

Path parameters

ephemeral_session_idinteger required

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

Request body

typestring required

git_refstring

disk_sizeinteger

container_countinteger

container_sizeinteger

commandstring

envobject

handlestring

certificatestring

private_keystring

destination_regionstring

interactiveboolean

destination_accountstring uri

destination_account_idinteger

deploy_image_idinteger

docker_refstring

automatedboolean

key_arnstring

instance_profilestring

provisioned_iopsinteger

dailyinteger

monthlyinteger

yearlyinteger

pitr_daysinteger

make_copyboolean

keep_finalboolean

enable_backupsboolean

enable_pitrboolean

settingsobject

Non-sensitive settings for the operation

sensitive_settingsobject

Sensitive settings for the operation (encrypted)

Example request

{
  "container_size": 1,
  "certificate": "certificate",
  "interactive": true,
  "instance_profile": "instance_profile",
  "type": "type",
  "docker_ref": "docker_ref",
  "container_count": 6,
  "pitr_days": 2,
  "keep_final": true,
  "deploy_image_id": 5,
  "make_copy": true,
  "key_arn": "key_arn",
  "destination_account": "https://openapi-generator.tech",
  "settings": {
    "key": "settings"
  },
  "destination_account_id": 5,
  "sensitive_settings": {
    "key": "sensitive_settings"
  },
  "enable_pitr": true,
  "destination_region": "destination_region",
  "disk_size": 0,
  "handle": "handle",
  "private_key": "private_key",
  "env": {
    "key": "env"
  },
  "command": "command",
  "automated": true,
  "provisioned_iops": 2,
  "daily": 7,
  "enable_backups": true,
  "git_ref": "git_ref",
  "monthly": 9,
  "yearly": 3
}

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