IBM Cloud for VMware Solutions API

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:

VMware Terms (PDF download)

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.

Get the list of supported data center locations

Get the list of supported data center locations.

GET /v1/locations

/v1/locations

Request

Custom Headers

x-global-transaction-id
string
Global transaction ID for request correlation.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/locations \
  -H 'Content-Type:application/json'
```

Response

Response Body

locations

List of available data center locations.

Status Code

200
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

/v1/server_types

Request

Custom Headers

x-global-transaction-id
string
Global transaction ID for request correlation.

Query Parameters

location
string
optional, default is all locations

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/server_types?location=DAL09 \
  -H 'Content-Type:application/json'
```

Response

Response Body

server_types

List of supported server CPU types.

Status Code

200
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

/v1/ram_types

Request

Custom Headers

x-global-transaction-id
string
Global transaction ID for request correlation.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/ram_types \
  -H 'Content-Type:application/json'
```

Response

Response Body

ram_types

List of supported RAM types.

Status Code

200
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

/v1/disk_types

Request

Custom Headers

x-global-transaction-id
string
Global transaction ID for request correlation.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/disk_types \
  -H 'Content-Type:application/json'
```

Response

Response Body

disk_types

List of supported disk types.

Status Code

200
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

/v1/shared_storage_tiers

Request

Custom Headers

x-global-transaction-id
string
Global transaction ID for request correlation.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/shared_storage_tiers \
  -H 'Content-Type:application/json'
```

Response

Response Body

shared_storage_tiers

List of supported shared storage tiers.

Status Code

200
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

/v1/vsphere_versions

Request

Custom Headers

x-global-transaction-id
string
Global transaction ID for request correlation.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/vsphere_versions \
  -H 'Content-Type:application/json'
```

Response

Response Body

vsphere_versions

List of supported vSphere versions.

Status Code

200
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

/v1/vcenters

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json'
```

Response

Response Body

vcenter[]

Status Code

200
Success.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
500
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

/v1/vcenters

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Query Parameters

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

Default: false
check_price
boolean
Whether to display the high level price associated with the order.

Default: false

Request Body

vcenter_order_data

Order specification with configurations.

```
curl -X POST \
  'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters?verify_only=false&check_price=false' \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json' \
  -d '{
    "name": "myvmware",
    "location": "sjc03",
    "root_domain": "mycompany.local",
    "host_prefix": "host",
    "subdomain": "myvmware",
    "domain_type": "primary",
    "dns_type": "vsi",
    "vsphere_version": "6.7",
    "hardware": {
      "quantity": 4,
      "customized_hardware": {
        "server": "INTEL_INTEL_XEON_4110_2_10",
        "ram": "RAM_64_GB_DDR4_2133_ECC_NON_REG",
        "disks": [
          "HARD_DRIVE_960GB_SSD_SED_5DWPD",
          "HARD_DRIVE_960GB_SSD_SED_5DWPD"
        ],
        "vsan_cache_disks": [
          "HARD_DRIVE_960GB_SSD_SED_5DWPD",
          "HARD_DRIVE_960GB_SSD_SED_5DWPD"
        ]
      }
    },
    "license_keys": {
      "vcenter": {
        "key": ""
      },
      "nsx": {
        "key": "",
        "license_type": "base"
      },
      "vsphere": {
        "key": ""
      },
      "vsan": {
        "key": "",
        "license_type": "advanced"
      }
    }
  }'
```
curl -X POST \ 'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters?verify_only=false&check_price=false' \ -H 'authorization: Bearer <IAM_token>' \ -H 'Content-Type:application/json' \ -d '{ "name": "myvmware", "location": "sjc03", "root_domain": "mycompany.local", "host_prefix": "host", "subdomain": "myvmware", "domain_type": "primary", "dns_type": "vsi", "vsphere_version": "6.7", "hardware": { "quantity": 4, "customized_hardware": { "server": "INTEL_INTEL_XEON_4110_2_10", "ram": "RAM_64_GB_DDR4_2133_ECC_NON_REG", "disks": [ "HARD_DRIVE_960GB_SSD_SED_5DWPD", "HARD_DRIVE_960GB_SSD_SED_5DWPD" ], "vsan_cache_disks": [ "HARD_DRIVE_960GB_SSD_SED_5DWPD", "HARD_DRIVE_960GB_SSD_SED_5DWPD" ] } }, "license_keys": { "vcenter": { "key": "" }, "nsx": { "key": "", "license_type": "base" }, "vsphere": { "key": "" }, "vsan": { "key": "", "license_type": "advanced" } } }'

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request for creating the vCenter Server instance has been accepted.
400
Bad request. Check your request parameters.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
500
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}

/v1/vcenters/{instance_id}

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id> \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json'
```

Response

Response Body

vcenter_detail

Status Code

200
Success.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
500
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}

/v1/vcenters/{instance_id}

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.

```
curl -X DELETE \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id> \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json'
```

Response

Status Code

202
Success. The request for deleting the vCenter Server instance has been accepted.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
500
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

/v1/vcenters/{instance_id}/history

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.

Query Parameters

start_date
date
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.
end_date
date
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.

```
curl -X GET \
  https://api-dev.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/history?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json'
```

Response

Response Body

history_message[]

history messages

Status Code

200
Success.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
500
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

/v1/vcenters/{instance_id}/clusters

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json'
```

Response

Response Body

cluster[]

Status Code

200
Success.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
500
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

/v1/vcenters/{instance_id}/clusters

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.

Query Parameters

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

Default: false
check_price
boolean
Whether to display the high level price associated with the order.

Default: false

Request Body

cluster_order_data

Cluster order specification with configurations.

```
curl -X POST \
  'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters?verify_only=false&check_price=false' \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json' \
  -d '{
    "cluster_name": "mycluster",
    "location": "sjc03",
    "is_default_pod": true,
    "hardware": {
      "quantity": 2,
      "customized_hardware": {
        "server": "INTEL_INTEL_XEON_4110_2_10",
        "ram": "RAM_64_GB_DDR4_2133_ECC_NON_REG"
      }
    },
    "network": {
      "private_only": false
    },
    "license_keys": {
      "vsphere": {
        "key": ""
      }
    },
    "shared_storages": [
      {
        "iops": "LOW_INTENSITY_TIER_Max_12000",
        "quantity": 1,
        "volume": 1000,
        "size": "STORAGE_SPACE_FOR_0_25_IOPS_PER_GB_Max_100"
      }
    ]
  }'
```
curl -X POST \ 'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters?verify_only=false&check_price=false' \ -H 'authorization: Bearer <IAM_token>' \ -H 'Content-Type:application/json' \ -d '{ "cluster_name": "mycluster", "location": "sjc03", "is_default_pod": true, "hardware": { "quantity": 2, "customized_hardware": { "server": "INTEL_INTEL_XEON_4110_2_10", "ram": "RAM_64_GB_DDR4_2133_ECC_NON_REG" } }, "network": { "private_only": false }, "license_keys": { "vsphere": { "key": "" } }, "shared_storages": [ { "iops": "LOW_INTENSITY_TIER_Max_12000", "quantity": 1, "volume": 1000, "size": "STORAGE_SPACE_FOR_0_25_IOPS_PER_GB_Max_100" } ] }'

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request for adding the new cluster has been accepted.
400
Bad request. Check your request parameters.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
500
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 cluster

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

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

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

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.
cluster_id
string
Cluster ID.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters/<cluster_id> \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json'
```

Response

Response Body

cluster_detail

Status Code

200
Success.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
500
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}

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

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.
cluster_id
string
Cluster ID.

```
curl -X DELETE \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters/<cluster_id> \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json'
```

Response

Status Code

202
Success. The request for deleting the cluster has been accepted.
401
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

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

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.
cluster_id
string
Cluster ID.

Query Parameters

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

Default: false
check_price
boolean
Whether to display the high level price associated with the order.

Default: false

Request Body

hosts_order_data

Parameters for adding new hosts.

```
curl -X POST \
  'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters/<cluster_id>/hosts?verify_only=false&check_price=false' \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json' \
  -d '{
    "quantity": 2,
    "maintenance_mode": false
  }'
```

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request for adding new hosts has been accepted.
400
Bad request. Check your request parameters.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
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. 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

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

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.
cluster_id
string
Cluster ID.

Request Body

object

Parameters for deleting hosts.

```
curl -X PATCH \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters/<cluster_id>/hosts \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json' \
  -d '{
      "action": "delete",
      "hosts": [
        "8945234",
        "7843945"
      ]
    }'
```

Response

Status Code

202
Success. The request for deleting the specified hosts has been accepted.
400
Bad request. Check your request parameters.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
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. 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

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

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.
cluster_id
string
Cluster ID.

Query Parameters

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

Default: false

Request Body

object

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

```
curl -X POST \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters/<cluster_id>/shared_storages?verify_only=false \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json' \
  -d '{
      "shared_storages": [
        {
          "iops": "LOW_INTENSITY_TIER",
          "size": "STORAGE_SPACE_FOR_0_25_IOPS_PER_GB",
          "volume": 2000,
          "quantity": 1
        }
      ]
  }'
```
curl -X POST \ https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters/<cluster_id>/shared_storages?verify_only=false \ -H 'authorization: Bearer <IAM_token>' \ -H 'Content-Type:application/json' \ -d '{ "shared_storages": [ { "iops": "LOW_INTENSITY_TIER", "size": "STORAGE_SPACE_FOR_0_25_IOPS_PER_GB", "volume": 2000, "quantity": 1 } ] }'

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request for adding new NFS storage has been accepted.
400
Bad request. Check your request parameters.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
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. 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

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

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.
cluster_id
string
Cluster ID.

Request Body

object

NFS storage ID list for deleting.

```
curl -X PATCH \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters/<cluster_id>/shared_storages \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json' \
  -d '{
        "action": "delete",
        "storage_ids": [
          "3422454323"
        ]
    }'
```

Response

Status Code

202
Success. The request for deleting the specified nfs storage has been accepted.
400
Bad request. Check your request parameters.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
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. 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

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

Request

Custom Headers

Authorization
string
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run ibmcloud iam oauth-tokens.
x-global-transaction-id
string
Global transaction ID for request correlation.

Path Parameters

instance_id
string
Instance ID.
cluster_id
string
Cluster ID.

```
curl -X GET \
  https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters/<cluster_id>/vlans \
  -H 'authorization: Bearer <IAM_token>' \
  -H 'Content-Type:application/json'
```

Response

Response Body

vlan[]

List of VLANs that the instance exposes.

Status Code

200
Success.
401
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
403
Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the VMware Solutions service.
404
Not found. The resource cannot be found.
500
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.

Introduction

Error handling

Authentication

Methods

Get the list of supported data center locations

Custom Headers

x-global-transaction-id

Response Body

id

geo

region

Status Code

200

No Sample Response

Get the list of supported server CPU types per location

Custom Headers

x-global-transaction-id

Query Parameters

location

Response Body

id

description

Status Code

200

No Sample Response

Get the list of supported RAM types

Custom Headers

x-global-transaction-id

Response Body

id

description

supported_server_types

Status Code

200

No Sample Response

Get the list of supported disk types

Custom Headers

x-global-transaction-id

Response Body

id

description

Status Code

200

No Sample Response

Get the list of supported shared storage tiers

Custom Headers

x-global-transaction-id

Response Body

iops

size

description

Status Code

200

No Sample Response

Get the list of supported vSphere versions

Custom Headers

x-global-transaction-id

Response Body

version

Status Code

200

No Sample Response

List all VMware vCenter Server instances

Custom Headers

Authorization

x-global-transaction-id

Response Body

id

name

creator

created_time

status

location

initial_version

current_version

domain_type

Status Code

200

401

500