API reference
Every HTTP endpoint of the containerinstances module: authentication, IAM action, parameters, bodies and status codes.
Generated from the module's code when its image was built — do not edit. Paths are relative to https://api.example.com.
Container Instance Backup Policy
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/backup-policy
Remove the instance's backup policy; backups already taken stay until they expire
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/backup-policy
The instance's backup policy, as the operator reports it
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/backup-policy
Set the instance's backup policy: schedule, retention, method, hooks
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Request body: BackupPolicySpecDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
Container Instance Compute Plans
GET /boundaries/{boundaryId}/resources/containerinstancecomputeplans
List all available containerinstancecomputeplans
- Authentication: required
- Operation name:
ListContainerInstanceComputePlans
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | PagedListResponse<ContainerInstancePlanDto> |
401 |
Not signed in, or the token is invalid | |
500 |
Internal error | ProblemDetails |
GET /boundaries/{boundaryId}/resources/containerinstancecomputeplans/{resourceId}
Get a specific containerinstancecomputeplan by ID
- Authentication: required
- Operation name:
GetContainerInstanceComputePlan
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | ContainerInstancePlanDto |
401 |
Not signed in, or the token is invalid | |
404 |
Not found | |
500 |
Internal error | ProblemDetails |
Container Instance Crates
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/crates
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/crates/{crateId}
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
crateId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/crates/{crateId}/logs
- Authentication: required
- IAM action:
containerinstance/readLogs— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
crateId |
path | string |
Yes |
previous |
query | boolean |
No |
process |
query | string |
No |
tail |
query | integer |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/readLogs at the evaluated scope |
Container Instance Files
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files
- Authentication: required
- IAM action:
containerinstance/writeFiles— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
component |
query | string |
No |
path |
query | string |
No |
recursive |
query | boolean |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/writeFiles at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files
- Authentication: required
- IAM action:
containerinstance/readFiles— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
component |
query | string |
No |
path |
query | string |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/readFiles at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/archive
- Authentication: required
- IAM action:
containerinstance/readFiles— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
component |
query | string |
No |
path |
query | string |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/readFiles at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/directory
- Authentication: required
- IAM action:
containerinstance/writeFiles— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Request body: MakeDirectoryRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/writeFiles at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/download
- Authentication: required
- IAM action:
containerinstance/readFiles— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
component |
query | string |
No |
path |
query | string |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/readFiles at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/move
- Authentication: required
- IAM action:
containerinstance/writeFiles— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Request body: MoveRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/writeFiles at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/upload
- Authentication: required
- IAM action:
containerinstance/writeFiles— evaluated at the resource in the path; a data action
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
component |
query | string |
No |
name |
query | string |
No |
path |
query | string |
No |
Request body: binary
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/writeFiles at the evaluated scope |
Container Instance Revisions
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/revisions
List a container instance's revisions, newest first
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/revisions/{from}/diff/{to}
Structured diff between two revisions
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
from |
path | integer |
Yes |
to |
path | integer |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/revisions/{number}
Read one revision, with its spec and parameters
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
number |
path | integer |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/revisions/{number}/rollback
Roll a container instance back to an earlier revision
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
number |
path | integer |
Yes |
ifMatchRevision |
query | integer |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
Container Instances
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/components/{component}/actions/redeploy
Re-deploy a single component of a container instance
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroup |
path | string |
Yes |
name |
path | string |
Yes |
component |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
POST /boundaries/{boundaryId}/resources/containerinstances/url
Preview the default public URL for a container instance endpoint
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Request body: ContainerInstanceUrlRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
ContainerInstance
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances
List all containerinstances in a resource group
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path - Operation name:
ListContainerInstances
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/config
Get list configuration for containerinstances
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path - Operation name:
GetContainerInstancesConfig
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
resourceGroupName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}
Delete a containerinstance
- Authentication: required
- IAM action:
containerinstance/delete— evaluated at the resource in the path - Operation name:
DeleteContainerInstance
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/delete at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}
Get a specific containerinstance
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path - Operation name:
GetContainerInstance
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}
Partially update an existing containerinstance using JSON Merge Patch
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path - Operation name:
PatchContainerInstance
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: any
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}
Create a new containerinstance
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path - Operation name:
CreateContainerInstance
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: ContainerInstanceDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}
Update an existing containerinstance
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path - Operation name:
UpdateContainerInstance
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: ContainerInstanceDto
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/actions/{action}
Execute a lifecycle action (start, stop, restart) on a containerinstance
- Authentication: required
- IAM action:
containerinstance/write— evaluated at the resource in the path - Operation name:
ExecuteContainerInstanceAction
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
action |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/write at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/scale
Get current scale of a containerinstance
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path - Operation name:
GetContainerInstanceScale
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/scale
Scale a containerinstance
- Authentication: required
- IAM action:
containerinstance/scale— evaluated at the resource in the path - Operation name:
ScaleContainerInstance
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: ScaleRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/scale at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots
List snapshots of a containerinstance
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path - Operation name:
ListContainerInstanceSnapshots
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots
Create a snapshot of a containerinstance
- Authentication: required
- IAM action:
containerinstance/createSnapshot— evaluated at the resource in the path - Operation name:
CreateContainerInstanceSnapshot
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Request body: CreateSnapshotRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/createSnapshot at the evaluated scope |
GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots/pitr-window
The point-in-time recovery window of a containerinstance
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path - Operation name:
GetContainerInstancePitrWindow
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots/{snapshotId}
Delete a snapshot of a containerinstance
- Authentication: required
- IAM action:
containerinstance/deleteSnapshot— evaluated at the resource in the path - Operation name:
DeleteContainerInstanceSnapshot
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
snapshotId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/deleteSnapshot at the evaluated scope |
POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots/{snapshotId}/restore
Restore a containerinstance from a snapshot
- Authentication: required
- IAM action:
containerinstance/restoreSnapshot— evaluated at the resource in the path - Operation name:
RestoreContainerInstanceFromSnapshot
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
resourceGroupName |
path | string |
Yes |
resourceName |
path | string |
Yes |
snapshotId |
path | uuid |
Yes |
Request body: RestoreSnapshotRequest
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/restoreSnapshot at the evaluated scope |
GET /boundaries/{boundaryId}/resources/containerinstances
List all containerinstances across all resource groups
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path - Operation name:
ListAllContainerInstances
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | uuid |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
GET /boundaries/{boundaryId}/resources/containerinstances/config
Get list configuration for all containerinstances
- Authentication: required
- IAM action:
containerinstance/read— evaluated at the resource in the path - Operation name:
GetAllContainerInstancesConfig
Parameters
| Name | In | Type | Required |
|---|---|---|---|
boundaryId |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid | |
403 |
The caller does not hold containerinstance/read at the evaluated scope |
Docs
GET /docs/containerinstances/manifest.json
- Authentication: required
- Operation name:
DocsManifest_containerinstances
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
GET /docs/containerinstances/{path}
- Authentication: required
- Operation name:
DocsFile_containerinstances
Parameters
| Name | In | Type | Required |
|---|---|---|---|
path |
path | string |
Yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | |
401 |
Not signed in, or the token is invalid |
Other endpoints
GET /instance-auth/check
- Authentication: none — anonymous callers are accepted
Parameters
| Name | In | Type | Required |
|---|---|---|---|
mi |
query | string |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK |
GET /instance-auth/oauth2/callback
- Authentication: none — anonymous callers are accepted
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK |
POST /instance-auth/oauth2/callback
- Authentication: none — anonymous callers are accepted
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK |
POST /instance-auth/oauth2/sign_out
- Authentication: none — anonymous callers are accepted
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK |
GET /instance-auth/oauth2/start
- Authentication: none — anonymous callers are accepted
Parameters
| Name | In | Type | Required |
|---|---|---|---|
rd |
query | string |
No |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK |
GET /readyz
- Authentication: none — anonymous callers are accepted
- Operation name:
StackshipReadiness
Responses
| Status | Meaning | Body |
|---|
Schemas
BackupPolicyHookDto
| Property | Type | Nullable |
|---|---|---|
backup |
string [] |
Yes |
container |
string |
No |
restore |
string [] |
Yes |
timeout |
string |
Yes |
BackupPolicySpecDto
| Property | Type | Nullable |
|---|---|---|
hooks |
BackupPolicyHookDto [] |
Yes |
method |
string |
No |
paused |
boolean |
No |
retention |
string |
No |
schedule |
string |
No |
ContainerInstanceComponentDto
| Property | Type | Nullable |
|---|---|---|
computePlan |
string |
Yes |
containers |
ContainerInstanceContainerDto [] |
No |
cpu |
string |
Yes |
hardened |
boolean |
No |
identityInjection |
boolean |
No |
initContainers |
ContainerInstanceContainerDto [] |
Yes |
memory |
string |
Yes |
name |
string |
No |
replicas |
integer |
No |
runAsGroup |
integer |
Yes |
runAsUser |
integer |
Yes |
scaling |
ContainerInstanceScalingDto |
Yes |
startupOrder |
integer |
No |
volumes |
ContainerInstanceVolumeDto [] |
Yes |
ContainerInstanceComponentStatusDto
| Property | Type | Nullable |
|---|---|---|
message |
string |
Yes |
name |
string |
No |
observedImageDigests |
map (string) |
Yes |
phase |
string |
Yes |
readyReplicas |
integer |
No |
ContainerInstanceContainerDto
| Property | Type | Nullable |
|---|---|---|
args |
string [] |
Yes |
command |
string [] |
Yes |
env |
ContainerInstanceEnvVarDto [] |
Yes |
image |
string |
No |
mounts |
ContainerInstanceMountDto [] |
Yes |
name |
string |
No |
ports |
ContainerInstancePortDto [] |
Yes |
probes |
ContainerInstanceProbesDto |
Yes |
sourceRef |
string |
Yes |
tag |
string |
No |
ContainerInstanceDto
| Property | Type | Nullable |
|---|---|---|
backupable |
boolean |
No |
boundary |
string |
No |
boundaryId |
uuid |
No |
clusterId |
uuid |
No |
clusterName |
string |
No |
collection |
string |
No |
componentStatus |
ContainerInstanceComponentStatusDto [] |
Yes |
components |
ContainerInstanceComponentDto [] |
No |
createdAt |
date-time |
No |
currentWave |
integer |
Yes |
endpointStatus |
ContainerInstanceEndpointStatusDto [] |
Yes |
endpoints |
ContainerInstanceEndpointDto [] |
Yes |
hasIdentity |
boolean |
No |
id |
uuid |
No |
name |
string |
No |
phase |
string |
Yes |
region |
string |
No |
resourceGroup |
string |
No |
status |
string |
No |
tags |
map (string) |
No |
templateRef |
ContainerInstanceTemplateRefDto |
Yes |
ContainerInstanceEmptyDirDto
| Property | Type | Nullable |
|---|---|---|
sizeLimit |
string |
Yes |
ContainerInstanceEndpointDto
| Property | Type | Nullable |
|---|---|---|
authGuard |
boolean |
No |
component |
string |
No |
expose |
string |
No |
hostname |
string |
Yes |
issuer |
string |
Yes |
name |
string |
No |
paths |
string [] |
Yes |
port |
string |
No |
ssl |
string |
Yes |
ContainerInstanceEndpointStatusDto
| Property | Type | Nullable |
|---|---|---|
address |
string |
Yes |
name |
string |
No |
tlsReady |
boolean |
Yes |
url |
string |
Yes |
ContainerInstanceEnvVarDto
| Property | Type | Nullable |
|---|---|---|
name |
string |
No |
secretRef |
ContainerInstanceSecretRefDto |
Yes |
value |
string |
Yes |
ContainerInstanceFilesDto
| Property | Type | Nullable |
|---|---|---|
content |
map (string) |
Yes |
sensitive |
boolean |
No |
ContainerInstanceHpaDto
| Property | Type | Nullable |
|---|---|---|
maxReplicas |
integer |
No |
minReplicas |
integer |
No |
targetCpuPercent |
integer |
No |
ContainerInstanceMountDto
| Property | Type | Nullable |
|---|---|---|
path |
string |
No |
readOnly |
boolean |
No |
subPath |
string |
Yes |
volume |
string |
No |
ContainerInstancePersistentVolumeDto
| Property | Type | Nullable |
|---|---|---|
fsGroup |
integer |
Yes |
retainOnDelete |
boolean |
No |
size |
string |
No |
storageClass |
string |
Yes |
tier |
string |
Yes |
ContainerInstancePlanDto
| Property | Type | Nullable |
|---|---|---|
cpu |
string |
No |
description |
string |
No |
id |
string |
No |
isProductionReady |
boolean |
No |
memory |
string |
No |
name |
string |
No |
ContainerInstancePortDto
| Property | Type | Nullable |
|---|---|---|
name |
string |
No |
port |
integer |
No |
protocol |
string |
Yes |
ContainerInstanceProbeDto
| Property | Type | Nullable |
|---|---|---|
command |
string [] |
Yes |
failureThreshold |
integer |
Yes |
initialDelaySeconds |
integer |
Yes |
path |
string |
Yes |
periodSeconds |
integer |
Yes |
port |
string |
No |
timeoutSeconds |
integer |
Yes |
type |
string |
No |
ContainerInstanceProbesDto
| Property | Type | Nullable |
|---|---|---|
liveness |
ContainerInstanceProbeDto |
Yes |
readiness |
ContainerInstanceProbeDto |
Yes |
startup |
ContainerInstanceProbeDto |
Yes |
ContainerInstanceScalingDto
| Property | Type | Nullable |
|---|---|---|
hpa |
ContainerInstanceHpaDto |
Yes |
strategy |
string |
No |
ContainerInstanceSecretRefDto
| Property | Type | Nullable |
|---|---|---|
key |
string |
No |
vault |
string |
No |
ContainerInstanceTemplateRefDto
| Property | Type | Nullable |
|---|---|---|
slug |
string |
Yes |
version |
string |
Yes |
ContainerInstanceVolumeDto
| Property | Type | Nullable |
|---|---|---|
emptyDir |
ContainerInstanceEmptyDirDto |
Yes |
files |
ContainerInstanceFilesDto |
Yes |
name |
string |
No |
persistent |
ContainerInstancePersistentVolumeDto |
Yes |
CreateSnapshotRequest
| Property | Type | Nullable |
|---|---|---|
description |
string |
Yes |
ttlHours |
integer |
Yes |
MakeDirectoryRequest
| Property | Type | Nullable |
|---|---|---|
component |
string |
Yes |
path |
string |
No |
MoveRequest
| Property | Type | Nullable |
|---|---|---|
component |
string |
Yes |
from |
string |
No |
to |
string |
No |
PagedListResponse<ContainerInstancePlanDto>
| Property | Type | Nullable |
|---|---|---|
items |
ContainerInstancePlanDto [] |
No |
pagination |
PaginationMeta |
No |
PaginationMeta
| Property | Type | Nullable |
|---|---|---|
hasNextPage |
boolean |
No |
hasPreviousPage |
boolean |
No |
page |
integer |
No |
pageSize |
integer |
No |
totalItems |
integer |
No |
totalPages |
integer |
No |
RestoreSnapshotRequest
| Property | Type | Nullable |
|---|---|---|
targetTime |
date-time |
Yes |
ScaleRequest
| Property | Type | Nullable |
|---|---|---|
targetScale |
integer |
No |