Introduction

With IBM Cloud™ for VMware Solutions, you can quickly and seamlessly integrate or migrate your on-premises VMware workloads to the IBM Cloud by using the scalable, secure, and high-performance IBM Cloud infrastructure and the industry-leading VMware hybrid virtualization technology. You can easily deploy your VMware virtual environments and manage the infrastructure resources on IBM Cloud. At the same time, you can still use your familiar native VMware product console to manage the VMware workloads. For more information, see the IBM Cloud for VMware Solutions documentation.

By using the IBM Cloud for VMware Solutions 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 on 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 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

Get the list of supported data center locations

Get the list of supported data center locations.

GET /v1/locations
Request

Custom Headers

  • Global transaction ID for request correlation.

Response

List of available data center locations.

Status Code

  • Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported server CPU types per location

Get the list of supported server types per location.

GET /v1/server_types
Request

Custom Headers

  • Global transaction ID for request correlation.

Query Parameters

  • optional, default is all locations

Response

List of supported server CPU types.

Status Code

  • Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported RAM types

Get the list of supported RAM types.

GET /v1/ram_types
Request

Custom Headers

  • Global transaction ID for request correlation.

Response

List of supported RAM types.

Status Code

  • Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported disk types

Get the list of supported disk types.

GET /v1/disk_types
Request

Custom Headers

  • Global transaction ID for request correlation.

Response

List of supported disk types.

Status Code

  • Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported shared storage tiers

Get the list of supported shared storage tiers.

GET /v1/shared_storage_tiers
Request

Custom Headers

  • Global transaction ID for request correlation.

Response

List of supported shared storage tiers.

Status Code

  • Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported vSphere versions

Get the list of supported vSphere versions.

GET /v1/vsphere_versions
Request

Custom Headers

  • Global transaction ID for request correlation.

Response

List of supported vSphere versions.

Status Code

  • Success.

No Sample Response

This method does not specify any sample responses.

List all VMware vCenter Server instances

List all the VMware vCenter Server instances that the user can access.

GET /v1/vcenters
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Response

Status Code

  • Success.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Order a new VMware vCenter Server instance or verify the order

Order a new VMware vCenter Server instance or verify the order with specified configurations.

POST /v1/vcenters
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Query Parameters

  • Whether to verify the order only instead of performing the order for real.

    Default: false

Order specification with configurations.

Response

Status Code

  • Success. The request has been successfully verified.

  • Success. The request for creating the vCenter Server instance has been accepted.

  • Bad request. Check your request parameters.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Retrieve the detailed information of a VMware vCenter Server instance

Retrieve the detailed information of a VMware vCenter Server instance.

GET /v1/vcenters/{instance_id}
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

Response

Status Code

  • Success.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Delete a VMware vCenter Server instance

Delete a VMware vCenter Server instance.

DELETE /v1/vcenters/{instance_id}
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

Response

Status Code

  • Success. The request for deleting the vCenter Server instance has been accepted.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

List all history messages for a specified VMware vCenter Server instance

List all the history messages in a specified VMware vCenter Server instance within the given timeframe.

GET /v1/vcenters/{instance_id}/history
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

Query Parameters

  • The start date from which to retrieve history messages. If the date is not defined, the date when the instance was deployed is employed. The format is YYYY-MM-DD.

  • The end date from which to retrieve history messages. If the date is not defined, the current date is employed. The format is YYYY-MM-DD.

Response

history messages

Status Code

  • Success.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

List all the clusters for a specified VMware vCenter Server instance

List all the clusters that are deployed in a specified VMware vCenter Server instance.

GET /v1/vcenters/{instance_id}/clusters
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

Response

Status Code

  • Success.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Add a cluster for a specified VMware vCenter Server instance or verify the order

Add a cluster for a specified VMware vCenter Server instance or verify the order.

POST /v1/vcenters/{instance_id}/clusters
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

Query Parameters

  • Whether to verify the order only instead of performing the order for real.

    Default: false

Cluster order specification with configurations.

Response

Status Code

  • Success. The request has been successfully verified.

  • Success. The request for adding the new cluster has been accepted.

  • Bad request. Check your request parameters.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Retreive the detailed information of a cluster

Retreive the detailed information of a specified cluster deployed in a specified VMware vCenter Server instance.

GET /v1/vcenters/{instance_id}/clusters/{cluster_id}
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

  • Cluster ID.

Response

Status Code

  • Success.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Delete a cluster

Delete a specified cluster from a specified VMware vCenter Server instance.

DELETE /v1/vcenters/{instance_id}/clusters/{cluster_id}
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

  • Cluster ID.

Response

Status Code

  • Success. The request for deleting the cluster has been accepted.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

No Sample Response

This method does not specify any sample responses.

Add new hosts to a specified cluster

Add new hosts to a specified cluster for a specified VMware vCenter Server instance.

POST /v1/vcenters/{instance_id}/clusters/{cluster_id}/hosts
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

  • Cluster ID.

Query Parameters

  • Whether to verify the order only instead of performing the order for real.

    Default: false

Parameters for adding new hosts.

Response

Status Code

  • Success. The request has been successfully verified.

  • Success. The request for adding new hosts has been accepted.

  • Bad request. Check your request parameters.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Conflict. The request cannot be completed because of a conflict with the current state of the target resource.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Delete hosts from a specified cluster

Delete hosts from a specified cluster for a specified VMware vCenter Server instance.

PATCH /v1/vcenters/{instance_id}/clusters/{cluster_id}/hosts
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

  • Cluster ID.

Parameters for deleting hosts.

Response

Status Code

  • Success. The request for deleting the specified hosts has been accepted.

  • Bad request. Check your request parameters.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Conflict. The request cannot be completed because of a conflict with the current state of the target resource.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Add shared storages to a specified cluster

Add new shared storages to a specified cluster for a specified VMware vCenter Server instance.

POST /v1/vcenters/{instance_id}/clusters/{cluster_id}/shared_storages
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

  • Cluster ID.

Query Parameters

  • Whether to verify the order only instead of performing the order for real.

    Default: false

Parameters for adding new Network File System (NFS) storage.

Response

Status Code

  • Success. The request has been successfully verified.

  • Success. The request for adding new NFS storage has been accepted.

  • Bad request. Check your request parameters.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Conflict. The request cannot be completed because of a conflict with the current state of the target resource.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Delete NFS storages from a specified cluster

Delete Network File System (NFS) storages from a specified cluster for a specified VMware vCenter Server instance.

PATCH /v1/vcenters/{instance_id}/clusters/{cluster_id}/shared_storages
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

  • Cluster ID.

NFS storage ID list for deleting.

Response

Status Code

  • Success. The request for deleting the specified nfs storage has been accepted.

  • Bad request. Check your request parameters.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Conflict. The request cannot be completed because of a conflict with the current state of the target resource.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Retrieve the detailed network interface of a cluster

Retrieve the detailed information of network interface from a specified cluster.

GET /v1/vcenters/{instance_id}/clusters/{cluster_id}/vlans
Request

Custom Headers

  • Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.

  • Global transaction ID for request correlation.

Path Parameters

  • Instance ID.

  • Cluster ID.

Response

List of VLANs that the instance exposes.

Status Code

  • Success.

  • Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.

  • Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.

  • Not found. The resource cannot be found.

  • Internal server error. Your request cannot be processed. Please wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.