Container Service API Operations Index
All available Container Service API Operations
Adapter
DELETE
Adapter Delete
Generic DELETE to access xenon Adapter API
GET
Adapter Get
Generic GET to access xenon Adapter API
PATCH
Adapter Patch
Generic PATCH to access xenon Adapter API
POST
Adapter Post
Generic POST to access xenon Adapter API
PUT
Adapter Put
Generic PUT to access xenon Adapter API
Api
GET
Auth Session Controller.get
Retrieve authorities of the current user.
POST
Catalog Request Callback Controller.post Submission Extension
Performs additional actions post submission.
POST
Catalog Request Callback Controller.rollback Request
Handles the direction to rollback a rejected request from the Service Catalog.
POST
Catalog Request Callback Controller.submit Request
Handles submitted Request from the Service Catalog to the Container service.
POST
Catalog Request Callback Controller.validate Request
Handles the validation callback for an unsubmitted Request from the Service Catalog. This callback is used to both validate the request as well obtain additional properties if needed before the request is submitted.
POST
Composition Callback Request Controller.allocate Component
Accepts a new request to allocate a Container component from composition service.
POST
Composition Callback Request Controller.create
Accepts a new request to provision a Container component type from composition service.
POST
Composition Callback Request Controller.deallocate Component
Accepts a new request to deallocate a Container component from composition service.
GET
Container Image Controller.find By Query
Search a docker registry.
GET
Container Image Tags Controller.find By Query
List available tags for a docker image.
GET
Container Resource Controller.get Resource
Retrieves a single resource by its unique identifier.
POST
Favorite Image Populate In Embedded Controller.populate Images For Tenants
Populate default popular images for each tenant
GET
Kubernetes Pod Log Controller.get
Retrieve pod logs.
POST
Network Callback Request Controller.allocate Component
Accepts a new request to allocate a Container Network component from network service.
POST
Network Callback Request Controller.deallocate Component
Accepts a new request to deallocate a Container Network component from network service.
POST
Network Callback Request Controller.submit Request
Accepts a new request from network service to provision or perform a day-2 operation on a Network component type.
POST
PKS Cluster Config Controller.add Cluster
Configure existing PKS cluster in vRA container service
GET
PKS Cluster List Controller.list Clusters
List all available PKS clusters or a single one for a given PKS endpoint. If a cluster is passed then list only the requested one.
GET
PKS Plan List Controller.list Plans
List available PKS plans for a given PKS endpoint.
POST
Retrieves collection Of resources By resource type.
Retrieves collection of resources by resource type.
GET
Template Search Controller.find By Query
Find container images by query.
POST
Triggers data collection Of all hosts and associated containers per containerType and related provider.
Triggers data collection of all hosts and associated containers per containerType and related provider.
POST
Triggers full data collection.
Triggers full data collection.
Authentication
POST
Create Auth Credentials Service State
Creates a AuthCredentialsServiceState.
DELETE
Delete Auth Credentials Service State
Deletes a AuthCredentialsServiceState.
GET
Get Auth Credentials Service State
Retrieves a AuthCredentialsServiceState.
GET
List Auth Credentials Service State
Retrieves all AuthCredentialsServiceStates.
PATCH
Patch Auth Credentials Service State
Patches a AuthCredentialsServiceState.
PUT
Update Auth Credentials Service State
Updates a AuthCredentialsServiceState.
Business Groups
GET
Group Tenant Controller.get
Retrieves the Business Group and Tenant info from the identity-service and transformed in group property.
GET
Group Tenant Controller.list
Retrieves all Business Group and Tenant infos from the identity-service and transformed in group property.
Closures
POST
Create Closure Description
Creates a ClosureDescription.
POST
Create Closure State
Creates a ClosureState.
DELETE
Delete Closure Description
Deletes a ClosureDescription.
DELETE
Delete Closure State
Deletes a ClosureState.
GET
Get Closure Description
Retrieves a ClosureDescription.
GET
Get Closure State
Retrieves a ClosureState.
GET
List Closure Description
Retrieves all ClosureDescriptions. list ClosureDescriptions.
GET
List Closure State
Retrieves all ClosureStates.
PATCH
Patch Closure Description
Patches a ClosureDescription.
PATCH
Patch Closure State
Patches a ClosureState.
POST
Run Closure
Runs a Closure.
PUT
Update Closure Description
Updates a ClosureDescription.
PUT
Update Closure State
Updates a ClosureState.
Cluster
POST
Add Cluster Host
Add host to cluster.
POST
Create Cluster
Creates a cluster.
DELETE
Delete Cluster
Delete a cluster.
GET
List All Clusters
Retrieves all clusters.
GET
List Cluster Hosts
Retrieves all hosts for a given cluster.
PATCH
Patch Cluster
Update a cluster.
DELETE
Remove Cluster Host
Remove host from cluster.
GET
Retrieve Cluster
Retrieve a cluster.
Composite
POST
Clone Composite Description
Creates a clone of the CompositeDescription.
POST
Create Composite Component
Creates a CompositeComponent.
POST
Create Composite Description
Creates a CompositeDescription.
DELETE
Delete Composite Component
Deletes a CompositeComponent.
DELETE
Delete Composite Description
Deletes a CompositeDescription.
GET
Export Composite Description
Exports the Composite Description in YAML format.
GET
Get Composite Component
Retrieves a CompositeComponent.
GET
Get Composite Description
Retrieves a CompositeDescription or the images of it's descriptions as CompositeDescriptionImages.
POST
Import Composite Description
Imports the YAML content as a Composite Description.
GET
List Composite Component
Retrieves all CompositeComponents.
GET
List Composite Description
Retrieves all CompositeDescriptions.
PATCH
Patch Composite Component
Patches a CompositeComponent.
PATCH
Patch Composite Description
Patches a CompositeDescription.
PUT
Update Composite Component
Updates a CompositeComponent.
PUT
Update Composite Description
Updates a CompositeDescription.
Compute Management
POST
Create Compute State
Creates a ComputeState.
DELETE
Delete Compute State
Deletes a ComputeState.
GET
Get Compute State
Retrieves a ComputeState.
GET
List Compute State
Retrieves all ComputeStates.
PATCH
Patch Compute State
Patches a ComputeState.
PUT
Update Compute State
Updates a ComputeState.
Config Properties
POST
Create Configuration State
Creates a ConfigurationState.
DELETE
Delete Configuration State
Deletes a ConfigurationState.
GET
Get Configuration State
Retrieves a ConfigurationState.
GET
List Configuration States
Retrieves all ConfigurationStates.
PATCH
Patch Configuration State
Patches a ConfigurationState.
PUT
Update Configuration State
Updates a ConfigurationState.
Container
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.
Converter
POST
Convert Container Description To Kubernetes Description
Converts a ContainerDescription to KubernetesDescription.
Data Collection
PATCH
Patch Container Host Data Collection State
Patches a ContainerHostDataCollectionState.
Deployment Policy
POST
Create Deployment Policy
Creates a DeploymentPolicy.
DELETE
Delete Deployment Policy
Deletes a DeploymentPolicy.
GET
Get Deployment Policy
Retrieves a DeploymentPolicy.
GET
List Deployment Policies
Retrieves all DeploymentPolicies.
PATCH
Patch Deployment Policy
Patches a DeploymentPolicy.
PUT
Update Deployment Policy
Updates a DeploymentPolicy.
Elastic Placement Zone
POST
Create Elastic Placement Zone Configuration State
Creates an ElasticPlacementZoneConfigurationState.
POST
Create Elastic Placement Zone State
Creates an ElasticPlacementZoneState.
DELETE
Delete Elastic Placement Zone Configuration State
Deletes an ElasticPlacementZoneConfigurationState.
DELETE
Delete Elastic Placement Zone State
Deletes an ElasticPlacementZoneState.
GET
Get Elastic Placement Zone Configuration State
Retrieves an ElasticPlacementZoneConfigurationState.
GET
Get Elastic Placement Zone State
Retrieves an ElasticPlacementZoneState.
GET
List Elastic Placement Zone Configuration State
Retrieves all ElasticPlacementZoneConfigurationStates.
GET
List Elastic Placement Zone State
Retrieves all ElasticPlacementZoneStates.
PATCH
Patch Elastic Placement Zone Configuration State
Patches an ElasticPlacementZoneConfigurationState.
PATCH
Patch Elastic Placement Zone State
Patches an ElasticPlacementZoneState.
PUT
Update Elastic Placement Zone Configuration State
Updates an ElasticPlacementZoneConfigurationState.
PUT
Update Elastic Placement Zone State
Updates an ElasticPlacementZoneState.
Events
POST
Create Event Log State
Creates a EventLogState.
DELETE
Delete Event Log State
Deletes a EventLogState.
GET
Get Event Log State
Retrieves a EventLogState.
GET
List Event Log State
Retrieves all EventLogStates.
PATCH
Patch Event Log State
Patches a EventLogState.
PUT
Update Event Log State
Updates a EventLogState.
Favorite Image
DELETE
Delete Favorite Image
Deletes a FavoriteImage
Favorite Images
POST
Add Image To Favorites
Adds an image to favorites.
GET
List Favorite Images
Retrieve the favorite images.
Images
GET
Popular Images Controller.get Popular Images
Retrieve the popular images.
Kube Config
GET
Export Kube Config
Exports KubeConfig file for a given Kubernetes host.
Kubernetes
POST
Create Generic Kubernetes Entity State
Creates a GenericKubernetesEntityState.
POST
Create Kubernetes Deployment
Creates a KubernetesDeployment.
POST
Create Kubernetes Description
Creates a KubernetesDescription.
POST
Create Kubernetes Pod
Creates a KubernetesPod.
POST
Create Kubernetes Service
Creates a KubernetesService.
DELETE
Delete Generic Kubernetes Entity State
Deletes a GenericKubernetesEntityState.
DELETE
Delete Kubernetes Deployment
Deletes a KubernetesDeployment.
DELETE
Delete Kubernetes Description
Deletes a KubernetesDescription.
DELETE
Delete Kubernetes Pod
Deletes a KubernetesPod.
DELETE
Delete Kubernetes Service
Deletes a KubernetesService.
GET
Get Generic Kubernetes Entity State
Retrieves a GenericKubernetesEntityState.
GET
Get Kubernetes Deployment
Retrieves a KubernetesDeployment.
GET
Get Kubernetes Description
Retrieves a KubernetesDescription.
GET
Get Kubernetes Pod
Retrieves a KubernetesPod.
GET
Get Kubernetes Service
Retrieves a KubernetesService.
GET
List Generic Kubernetes Entity States
Retrieves all GenericKubernetesEntityStates.
GET
List Kubernetes Deployment
Retrieves all KubernetesDeployments.
GET
List Kubernetes Description
Retrieves all KubernetesDescriptions.
GET
List Kubernetes Pod
Retrieves all KubernetesPods.
GET
List Kubernetes Service
Retrieves all KubernetesServices.
PATCH
Patch Generic Kubernetes Entity State
Patches a GenericKubernetesEntityState.
PATCH
Patch Kubernetes Deployment
Patches a KubernetesDeployment.
PATCH
Patch Kubernetes Description
Patches a KubernetesDescription.
PATCH
Patch Kubernetes Pod
Patches a KubernetesPod.
PATCH
Patch Kubernetes Service
Patches a KubernetesService.
PUT
Update Generic Kubernetes Entity State
Updates a GenericKubernetesEntityState.
PUT
Update Kubernetes Deployment
Updates a KubernetesDeployment.
PUT
Update Kubernetes Description
Updates a KubernetesDescription.
PUT
Update Kubernetes Pod
Updates a KubernetesPod.
PUT
Update Kubernetes Service
Updates a KubernetesService.
Log
GET
Get Log Service State
Retrieves a LogServiceState.
Notifications
GET
Get Notifications
Retrieves request and eventlog notifications.
Pks
POST
Create Pks Endpoint
Creates a PksEndpoint.
DELETE
Delete Pks Endpoint
Deletes a PksEndpoint.
GET
Get Pks Endpoint
Retrieves a PksEndpoint.
GET
List Pks Endpoint
Retrieves all PksEndpoints.
PATCH
Patch Pks Endpoint
Patches a PksEndpoint.
PUT
Update Pks Endpoint
Updates a PksEndpoint.
Placements
POST
Create Group Resource Placement State
Creates a GroupResourcePlacementState.
DELETE
Delete Group Resource Placement State
Deletes a GroupResourcePlacementState.
GET
Get Group Resource Placement State
Retrieves a GroupResourcePlacementState.
GET
List Group Resource Placement State
Retrieves all GroupResourcePlacementStates.
PATCH
Patch Group Resource Placement State
Patches a GroupResourcePlacementState.
PUT
Update Group Resource Placement State
Updates a GroupResourcePlacementState.
Post
POST
Post To Get
The service accepts post request with long uri as body. Then a get request is sent using the uri in the body. The service workarounds an issue when the uri is too long and netty does not accept it
Registry
POST
Create Registry State
Creates a RegistryState.
DELETE
Delete Registry State
Deletes a RegistryState.
GET
Get Registry State
Retrieves a RegistryState.
GET
List Registry State
Retrieves all RegistryStates.
PATCH
Patch Registry State
Patches a RegistryState.
PUT
Update Registry Host Spec
Helper method for adding and validating docker registries.
PUT
Update Registry State
Updates a RegistryState.
Request Status
DELETE
Delete Container Request Status
Deletes a ContainerRequestStatus.
GET
Get Container Request Status
Retrieves a ContainerRequestStatus.
GET
List Container Request Status
Retrieves all ContainerRequestStatuss.
PATCH
Patch Container Request Status
Patches a ContainerRequestStatus.
Requests
POST
Create Request Broker State
Creates a RequestBrokerState.
DELETE
Delete Request Broker State
Deletes a RequestBrokerState.
GET
Get Request Broker State
Retrieves a RequestBrokerState.
GET
List Request Broker State
Retrieves all RequestBrokerStates.
PATCH
Patch Request Broker State
Patches a RequestBrokerState.
PUT
Update Request Broker State
Updates a RequestBrokerState.
Resource Pool
POST
Create Resource Pool State
Creates a ResourcePoolState.
DELETE
Delete Resource Pool State
Deletes a ResourcePoolState.
GET
Get Resource Pool State
Retrieves a ResourcePoolState.
GET
List Resource Pool State
Retrieves all ResourcePoolStates.
PATCH
Patch Resource Pool State
Patches a ResourcePoolState.
PUT
Update Resource Pool State
Updates a ResourcePoolState.
Service Document
POST
Create Service Document Delete Task State
Creates a ServiceDocumentDeleteTaskState.
DELETE
Delete Service Document Delete Task State
Deletes a ServiceDocumentDeleteTaskState.
GET
Get Service Document Delete Task State
Retrieves a ServiceDocumentDeleteTaskState.
GET
List Service Document Delete Task State
Retrieves all ServiceDocumentDeleteTaskState.
PATCH
Patch Service Document Delete Task State
Patches a ServiceDocumentDeleteTaskState.
PUT
Update Service Document Delete Task State
Updates a ServiceDocumentDeleteTaskState.
Ssl
POST
Create Ssl Trust Certificate State
Creates a SslTrustCertificateState.
POST
Create Ssl Trusted Certificate State
Creates a SslTrustedCertificateState.
DELETE
Delete Ssl Trust Certificate State
Deletes a SslTrustCertificateState.
DELETE
Delete Ssl Trusted Certificate State
Deletes a SslTrustedCertificateState.
GET
Get Ssl Trust Certificate State
Retrieves a SslTrustCertificateState.
GET
Get Ssl Trusted Certificate State
Retrieves a SslTrustedCertificateState.
GET
List Ssl Trust Certificate State
Retrieves all SslTrustCertificateStates.
GET
List Ssl Trusted Certificate State
Retrieves all SslTrustedCertificateStates.
PATCH
Patch Ssl Trust Certificate State
Patches a SslTrustCertificateState.
PATCH
Patch Ssl Trusted Certificate State
Patches a SslTrustedCertificateState.
PUT
Ssl Trust Import Controller.update
Imports and transforms a Server certificate from URI and store if valid and accepted.
PUT
Update Ssl Trust Certificate State
Updates a SslTrustCertificateState.
PUT
Update Ssl Trusted Certificate State
Updates a SslTrustedCertificateState.
Tagging
POST
Create Tag Assignment Request
Creates a TagAssignmentRequest.
POST
Create Tag State
Creates a TagState.
DELETE
Delete Tag State
Deletes a TagState.
GET
Get Tag State
Retrieves a TagState.
GET
List Tag State
Retrieves all TagStates.
PATCH
Patch Tag State
Patches a TagState.
PUT
Update Tag State
Updates a TagState.