Introduction

With IBM Cloud™ for VMware Solutions Shared, you can quickly and seamlessly migrate or deploy VMware workloads to the cloud on top of your professionally-managed VMware infrastructure. IBM provides a self-service on-demand VMware cloud computing platform with vCloud Director running on IBM Cloud. This infrastructure-as-a-service (IaaS) pay-as-you-go offering allows users to consume specific vCPU, storage, vRAM, Network, and IP, as needed.

By using the IBM Cloud for VMware Solutions Shared REST API you acknowledge that you have read and accepted the following third-party agreement:

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 type response indicates success, a 400 type response indicates a failure, and a 500 type response indicates an internal system error.

HTTP error code Description Recovery
200 Success The request was successful.
202 Success The request was submitted successfully.
400 Bad request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request because of missing or bad authentication token.
403 Forbidden The supplied authentication is not authorized to make this request. Contact the account owner to check your permissions.
409 Conflict The request cannot be completed because of a conflict with the current state of the target resource.
500 Internal server error Your request cannot be processed. Wait a few minutes and try again. If the error persists, contact IBM Support.

When an API operation fails, detailed information about the failure is provided in the response. In addition, in every response there is a header named x-global-transaction-id, which is a unique identifier for the API operation. When contacting IBM Support about API operation failures, you can provide the x-global-transaction-id for better debugging.

Authentication

To work with the API, you must add an IBM Cloud IAM access token in the API request authentication header:

-H 'Authorization: Bearer <IAM_TOKEN>'

You can retrieve an IBM Cloud IAM access token by using the IBM Cloud CLI, or by creating an API key and then exchanging the API key for an IBM Cloud IAM access token. For more information, see Getting an IAM token.

Methods

Check application status

GET /status
Request

No Request Parameters

This method does not accept any request parameters.

Response

Status Code

  • OK

Example responses

Return user-specific locations

GET /locations
Request

Custom Headers

Response

Status Code

  • OK

Example responses

Return currently available locations

GET /locations/catalog
Request

Custom Headers

Response

Status Code

  • OK

Example responses

Get new organization admin password

PUT /locations/{location}/password
Request

Custom Headers

Path Parameters

Response

Status Code

  • OK

Example responses

Return list of virtual data centers

GET /vdcs
Request

Custom Headers

Response

Status Code

  • OK

Example responses

Create a virtual data center

POST /vdcs
Request

Custom Headers

Response

Status Code

  • Accepted

Example responses

Show virtual data center

GET /vdcs/{vdc_uuid}
Request

Custom Headers

Path Parameters

Response

Status Code

  • OK

Example responses

Change virtual data center reservations

PUT /vdcs/{vdc_uuid}
Request

Custom Headers

Path Parameters

Response

Status Code

  • Accepted

No Sample Response

This method does not specify any sample responses.

Delete virtual data center

DELETE /vdcs/{vdc_uuid}
Request

Custom Headers

Path Parameters

Response

Status Code

  • OK

No Sample Response

This method does not specify any sample responses.