Container APIs

Container APIs
Operations
POST
Create Container Description
Creates a ContainerDescription.
POST
Create Container Network Description
Creates a ContainerNetworkDescription.
POST
Create Container Network State
Creates a ContainerNetworkState.
POST
Create Container State
Creates a ContainerState.
POST
Create Container Type
Creates a ContainerType.
POST
Create Container Volume Description
Creates a ContainerVolumeDescription.
POST
Create Container Volume State
Creates a ContainerVolumeState.
PUT
Create Or Update Container Type
Creates or updates a ContainerType.
DELETE
Delete Container Description
Deletes a ContainerDescription.
DELETE
Delete Container Network Description
Deletes a ContainerNetworkDescription.
DELETE
Delete Container Network State
Deletes a ContainerNetworkState.
DELETE
Delete Container State
Deletes a ContainerState.
DELETE
Delete Container Type
Deletes a ContainerType with the given ID.
DELETE
Delete Container Volume Description
Deletes a ContainerVolumeDescription.
DELETE
Delete Container Volume State
Deletes a ContainerVolumeState.
GET
Get Catalog Resource Item
Retrieves a catalog item related to the container item.
GET
Get Catalog Resource Item
Retrieves a catalog item related to the container item.
GET
Get Catalog Resource Item
Retrieves a catalog item related to the container item.
GET
Get Container Description
Retrieves a ContainerDescription.
GET
Get Container Network Description
Retrieves a ContainerNetworkDescription.
GET
Get Container Network State
Retrieves a ContainerNetworkState.
GET
Get Container State
Retrieves a ContainerState.
GET
Get Container Stats
Use ContainerStats endpoint (resources/container-stats) for getting the stats of a container.
GET
Get Container Stats
Retrieves a ServiceStats for container instance.
GET
Get Container Type
Retrieves a ContainerType.
GET
Get Container Volume Description
Retrieves a ContainerVolumeDescription.
GET
Get Container Volume State
Retrieves a ContainerVolumeState.
GET
List Container Description
Retrieves all ContainerDescriptions.
GET
List Container Network Description
Retrieves all ContainerNetworkDescriptions.
GET
List Container Network State
Retrieves all ContainerNetworkStates.
GET
List Container State
Retrieves all ContainerStates.
GET
List Container Types
Retrieves all ContainerType with specified paging, sorting and filtering parameters.
GET
List Container Volume Description
Retrieves all ContainerVolumeDescriptions.
GET
List Container Volume State
Retrieves all ContainerVolumeState.
PATCH
Patch Container Description
Patches a ContainerDescription.
PATCH
Patch Container Network Description
Patches a ContainerNetworkDescription.
PATCH
Patch Container Network State
Patches a ContainerNetworkState.
PATCH
Patch Container State
Patches a ContainerState.
PATCH
Patch Container Volume Description
Patches a ContainerVolumeDescription.
PATCH
Patch Container Volume State
Patches a ContainerVolumeState.
POST
Publishes A container description To catalog.
Publishes a container description to catalog.
PUT
Update Container Description
Updates a ContainerDescription.
PUT
Update Container Host Spec
Helper method for adding and validating container hosts.
PUT
Update Container Network Description
Updates a ContainerNetworkDescription.
PUT
Update Container Network State
Updates a ContainerNetworkState.
PUT
Update Container State
Updates a ContainerState.
PUT
Update Container Volume Description
Updates a ContainerVolumeDescription.
PUT
Update Container Volume State
Updates a ContainerVolumeState.
PUT
Update PKS Endpoint Spec
Helper method for adding and validating PKS endpoint.