IBM Cloud for VMware Solutions API

Introduction

Last updated: 2023-02-13

With IBM Cloud® for VMware Solutions, you can quickly and seamlessly integrate or migrate your on-premises VMware workloads to the IBM Cloud. This is done 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 VMware Solutions docs.

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)

Endpoint URLs

The API is available at:

https://api.vmware-solutions.cloud.ibm.com

This is a highly-available globally load balanced endpoint. Under normal conditions, API calls to this endpoint are directed to the nearest geographical region from where the endpoint API call is initiated. If the nearest geographical region is not available, the API calls are directed to the next closest regional endpoint.

To successfully invoke an API, the endpoint URL must be qualified with a method and authentication credential via IAM token in the request header.

Authentication

Authentication to the API is managed by IBM Cloud® Identity and Access Management (IAM). 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>'

To call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see Managing access for VMware Solutions.

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 Generating an IBM Cloud IAM token by using an API key.

Auditing

You can monitor API activity within your account by using the IBM Cloud Activity Tracker with LogDNA service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker with LogDNA. The specific event type is listed for each individual method.

For more information about how to track VMware Solutions activity, see Auditing events for VMware Solutions.

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. 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.

If no request body is provided, retrieve the user name and API key for the IBM Cloud infrastructure account that is linked to the current IBM Cloud account. Then enter the information in the VMware Solutions account settings. If a request body is provided, set the provided user name and API key for the IBM Cloud infrastructure account in the VMware Solutions account settings.

POST /v1/infra_credentials

Request

Custom Headers

Authorization
Required*
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

retrieve_only
boolean
Whether to only retrieve the IBM Cloud infrastructure API user information.

Default: false

Request Body

infra_credentials

The IBM Cloud infrastructure account information. The provided IBM Cloud infrastructure account ID should be consistent with the provided user name and API key.

Response

Response Body

account_infra_credentials

Status Code

200
Success. The request has been successfully performed.
400
Bad request. Check your request parameters.

No Sample Response

This method does not specify any sample responses.

Order a new vCenter Server (NSX-V) instance or verify the order with specified configurations.

POST /v1/vcenters

Request

Custom Headers

Authorization
Required*
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

Required*

vcenter_order_data

Order specification with configurations.

Example request (Use quotation marks for URL with parameters)

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters?verify_only=false&check_price=true'   -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_4210_2_20",
        "ram": "RAM_128_GB_DDR4_2133_ECC_REG",
        "disks": [
          "HARD_DRIVE_960GB_SSD",
          "HARD_DRIVE_960GB_SSD"
        ],
        "vsan_cache_disks": [
          "HARD_DRIVE_960GB_SSD",
          "HARD_DRIVE_960GB_SSD"
        ]
      }
    },
    "license_keys": {
      "nsx": {
        "license_type": "base"
      },
      "vsphere": {},
      "vsan": {
        "license_type": "advanced"
      }
    },
    "services": [
      {
        "service_info": {
          "service_id": "vSRX",
          "variables": {
            "nickname": "test-auto",
            "vsrx_license_type": "Standard Edition",
            "target_cluster": "mgmt"
            }
          }
        }
      ]
  }'

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Order a new vCenter Server (NSX-V) instance with edge gateway cluster or verify the order with specified configurations.

POST /v1/vcenters/edge

Request

Custom Headers

Authorization
Required*
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

Required*

vcs_edge_order_data

Order specification with configurations.

Example request (Use quotation marks for URL with parameters)

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/edge?verify_only=false&check_price=true'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
      "name": "vcs-edge",
      "subdomain": "subdomain",
      "root_domain": "mydomain.local",
      "vsphere_version": "6.7",
      "host_prefix": "host",
      "dns_type": "vsi",
      "license_keys": {
          "vcenter": {
              "key": "my_BYOL_key"
          },
          "nsx": {
              "license_type": "base"
          }
      },
      "management": {
          "cluster_name": "my-management-cluster",
          "location": "wdc04",
          "customized_hardware": {
              "server": "INTEL_INTEL_XEON_4210_2_20",
              "ram": "RAM_192_GB_DDR4_2133_ECC_REG",
              "disks": [
                  "HARD_DRIVE_960GB_SSD",
                  "HARD_DRIVE_960GB_SSD"
              ],
              "vsan_cache_disks": [
                  "HARD_DRIVE_NVME_750_GB_PCIE",
                  "HARD_DRIVE_NVME_750_GB_PCIE"
              ],
              "vsan_compression": true
          },
          "quantity": 4,
          "license_keys": {
              "vsan": {
                  "license_type": "advanced"
              }
          }
      },
      "edge": {
          "location": "wdc04",
          "cluster_name": "my-edge-cluster",
          "quantity": 2,
          "customized_hardware": {
              "server": "2U_VMW_BARE_METAL_GATEWAY_10_GBPS_4210",
              "ram": "RAM_64_GB_DDR4_2133_ECC_NON_REG"
          }
      },
      "services": [
          {
              "service_info": {
                  "service_id": "vSRX",
                  "variables": {
                      "nickname": "myservice",
                      "vsrx_license_type": "Standard Edition",
                      "target_cluster": "edge"
                  }
              }
          }
      ]
  }'

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request for creating the vCenter Server instance with NSX-T 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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Order a new vCenter Server instance with NSX-T or verify the order with specified configurations.

POST /v1/vcenters/nsxt

Request

Custom Headers

Authorization
Required*
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

Required*

nsxt_order_data

Order specification with configurations.

Example request (Use quotation marks for URL with parameters)

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/nsxt?verify_only=false&check_price=true'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
      "dns_type": "vsi",
      "license_keys": {
          "nsx": {
              "license_type": "dc_advanced"
          },
          "vcenter": {
              "key": "my-BYOL-key"
          }
      },
      "domain_type": "primary",
      "vsphere_version": "7.0",
      "vcs_type": "vcs_nsx_t",
      "name": "my-nsxt",
      "host_prefix": "host",
      "root_domain": "test.mydomain.local",
      "vcs_type": "vcs_nsx_t",
      "large_chassis_only": true,
      "management": {
          "cluster_name": "my-cluster-name",
          "customized_hardware": {
              "server": "INTEL_INTEL_XEON_5218_2_30",
              "ram": "RAM_192_GB_DDR4_2133_ECC_REG",
              "disks": [
                  "HARD_DRIVE_960GB_SSD",
                  "HARD_DRIVE_960GB_SSD"
              ],
              "vsan_cache_disks": [
                  "HARD_DRIVE_960GB_SSD",
                  "HARD_DRIVE_960GB_SSD"
              ],
              "vsan_compression": true
          },
          "quantity": 4,
          "location": "tor05",
          "license_keys": {
              "vsan": {
                  "license_type": "enterprise"
              }
          }
      },
      "workload": {
          "cluster_name": "my-wl-name",
          "customized_hardware": {
              "server": "INTEL_INTEL_XEON_5218_2_30",
              "ram": "RAM_192_GB_DDR4_2133_ECC_REG"
          },
          "quantity": 2,
          "host_names": [
              "host-a",
              "host-b"
          ],
          "location": "dal10",
          "shared_storages": [
              {
                  "iops": "READHEAVY_TIER",
                  "quantity": 1,
                  "size": "STORAGE_SPACE_FOR_2_IOPS_PER_GB",
                  "volume": 1000
              }
          ],
          "network": {
              "private_only": true,
              "uplink_speed": "25GB"
          }
      },
      "edge": {
          "location": "tor05",
          "cluster_name": "vcs-tc-edge",
          "quantity": 2,
          "host_names": [
              "edge-a",
              "edge-b"
          ],
          "customized_hardware": {
              "server": "2U_VMW_BARE_METAL_GATEWAY_10_GBPS_4210",
              "ram": "RAM_128_GB_DDR3_1333_REG_2"
          },
          "network": {
              "private_only": true
          }
      },
      "services": [
          {
              "service_info": {
                  "service_id": "vSRX",
                  "variables": {
                      "nickname": "myservice",
                      "vsrx_license_type": "Standard Edition",
                      "target_cluster": "edge"
                  }
              }
          }
      ]
  }'

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request for creating the vCenter Server instance with NSX-T 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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Order a new VMware vSphere cluster, verify the order, or get the order price.

POST /v1/vcenters/vss

Request

Custom Headers

Authorization
Required*
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

Required*

vss_order_data

Order specification with configurations.

Example request (Use quotation marks for URL with parameters)

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/vss?verify_only=false&check_price=true'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
      "license_keys": {
          "vsphere": {}
      },
      "vsphere_version": "7.0",
      "cluster_name": "my-cluster",
      "host_prefix": "host",
      "root_domain": "test.mydomain.com",
      "customized_hardware": {
          "server": "INTEL_INTEL_XEON_4210_2_20",
          "ram": "RAM_128_GB_DDR4_2133_ECC_REG"
      },
      "quantity": 1,
      "host_names": [
          "host-a"
      ],
      "location": "dal10",
      "network": {
          "private_only": false,
          "uplink_speed": "10GB"
      }
  }'

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request to create a VMware vSphere 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.
500
Internal server error. Your request cannot be processed. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Delete a VMware vSphere cluster.

DELETE /v1/vcenters/vss/{instance_id}

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Example request

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

Response

Status Code

202
Success. The request for deleting the VMware vSphere 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.
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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Retrieve the detailed information of a vCenter Server instance.

GET /v1/vcenters/{instance_id}

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Example request

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Delete a vCenter Server instance.

DELETE /v1/vcenters/{instance_id}

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Example request

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

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

POST /v1/vcenters/{instance_id}/clusters

Request

Custom Headers

Authorization
Required*
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
Required*
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

Required*

One of

Cluster order specification with configurations.

Example request to add workload cluster to NSX-V or NSX-T instance.

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters?verify_only=false&check_price=true'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "cluster_name": "mycluster",
    "host_prefix": "host",
    "location": "sjc03",
    "hardware": {
      "quantity": 2,
      "host_names": ["host-a", "host-b"]
      "large_chassis_only": true,
      "customized_hardware": {
        "server": "INTEL_INTEL_XEON_4210_2_20",
        "ram": "RAM_192_GB_DDR4_2133_ECC_REG"
      }
    },
    "shared_storages": [
      {
        "iops": "LOW_INTENSITY_TIER",
        "quantity": 1,
        "volume": 1000,
        "size": "STORAGE_SPACE_FOR_0_25_IOPS_PER_GB"
      }
    ],
    "network": {
        "private_only": true,
        "uplink_speed": "10GB"
    },
    "networking": {
        "public_vlan": {
            "id": 1234567,
            "primary_subnet_id": 4567890
        }
    }
  }'

Example request to add workload cluster to a multizone instance.

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters?verify_only=false&check_price=true'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "cluster_name": "vsan-workload-cluster",
    "host_prefix": "host",
    "datacenters": [
        "syd04",
        "syd05"
    ],
    "customized_hardware": {
        "server": "INTEL_INTEL_XEON_4210_2_20",
        "ram": "RAM_128_GB_DDR4_2133_ECC_REG",
        "disks": [
            "HARD_DRIVE_960GB_SSD",
            "HARD_DRIVE_960GB_SSD"
        ],
        "vsan_cache_disks": [
            "HARD_DRIVE_960GB_SSD",
            "HARD_DRIVE_960GB_SSD"
        ],
        "vsan_compression": true
    },
    "quantity": 4,
    "network": {
        "private_only": true,
        "uplink_speed": "10GB"
    }
  }'

Example request to add edge gateway cluster to an instance.

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/clusters?verify_only=false&check_price=true'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "cluster_name": "edge-cluster",
    "location": "syd04",
    "cluster_type": "edge",
    "customized_hardware": {
        "server": "2U_VMW_BARE_METAL_GATEWAY_10_GBPS_4210",
        "ram": "RAM_64_GB_DDR4_2133_ECC_NON_REG"
    },
    "quantity": 2,
    "network": {
        "private_only": true,
        "uplink_speed": "10GB"
    }
  }'

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

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

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

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
cluster_id
Required*
string
Cluster ID.

Example request

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Delete a specified cluster from a specified vCenter Server instance.

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

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
cluster_id
Required*
string
Cluster ID.

Example request

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 for a specified vCenter Server instance.

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

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
cluster_id
Required*
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

Required*

hosts_order_data

Parameters for adding new hosts.

Example request to add two hosts.

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

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

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

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

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
cluster_id
Required*
string
Cluster ID.

Request Body

Required*

object

Parameters for deleting hosts.

Example request

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Add new hosts to a specified VMware vSphere cluster.

POST /v1/vcenters/vss/{instance_id}/hosts

Request

Custom Headers

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

Path Parameters

instance_id
Required*
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

Required*

vss_hosts_order_data

Parameters for adding new hosts.

Example request to add two hosts.

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

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Delete hosts from a specified VMware vSphere cluster.

PATCH /v1/vcenters/vss/{instance_id}/hosts

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Request Body

Required*

object

Parameters for deleting hosts.

Example request

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

Response

Status Code

200
Success. The request for deleting the specified hosts has been accepted.
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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Get all billing item IDs of VMware vSphere cluster

GET /v1/vcenters/vss/{instance_id}/billing_items

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Example request

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

Response

Response Body

vss_billing_items

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Cancel a list of billing item IDs from a VMware vSphere cluster

PATCH /v1/vcenters/vss/{instance_id}/billing_items

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Request Body

object

Example request

curl -X PATCH   https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/vss/<instance_id>/billing_items   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
        "vss_lic_billing_ids": [
          123456789,
          987654321
        ]
      }'

Response

Status Code

202
Success. The request for deleting the license billing IDs from VMware vSphere 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.
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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

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

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

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
cluster_id
Required*
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

Required*

object

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

Example request

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

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

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

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
cluster_id
Required*
string
Cluster ID.

Request Body

Required*

object

NFS storage ID list for deleting.

Example request

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

List all the vCenter Server instances that the user can access. The key name is "vcenters".

GET /v2/vcenters

Request

Custom Headers

Authorization
Required*
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.

Example request

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

Response

Response Body

def_vcenters

The list of vCenters information in JSON format.

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

List all the history messages in a specified vCenter Server instance within the specified time frame. If the history messages are obtained, the key name is "history_messages". Otherwise the key name is "errors".

GET /v2/vcenters/{instance_id}/history

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Query Parameters

start_date
date
The start date from when history messages are retrieved. If it is not specified, the date when the instance was deployed is used. The format is YYYY-MM-DD.
end_date
date
The end date to when history messages are retrieved. If it is not specified, the current date is used. The format is YYYY-MM-DD.

Response

Response Body

def_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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

List all the clusters that are deployed in a specified vCenter Server instance as a JSON object. If the clusters are obtained, the key name is "clusters". Otherwise, the key name is "errors".

GET /v2/vcenters/{instance_id}/clusters

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Response

Response Body

def_clusters

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Retrieve the detailed information of network interface for a specified cluster as a JSON object. If the detailed network interface information is obtained, the key name is "array_vlans". Otherwise, the key name is "errors".

GET /v2/vcenters/{instance_id}/clusters/{cluster_id}/vlans

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
cluster_id
Required*
string
Cluster ID.

Response

Response Body

def_array_vlans

The list of VLANs that the instance exposes in JSON format.

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Retrieve the existing network of a specified cluster.

GET /v2/vcenters/{instance_id}/clusters/{cluster_id}/existing_network

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
cluster_id
Required*
string
Cluster ID.

Response

Response Body

def_array_vlans

The list of VLANs that the instance exposes in JSON format.

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Get the list of supported data center locations as a JSON object, and the key name is "locations".

GET /v2/locations

Request

Custom Headers

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

Example request

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

Response

Response Body

def_locations

Available data center locations in JSON format. The key name is "locations".

Status Code

200
Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported multizone region data center locations as a JSON object. The key name is "mzr_locations".

GET /v2/mzr_locations

Request

Custom Headers

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

Example request

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

Response

Response Body

def_mzr_locations

The list of available multizone region data center locations in JSON format. The key name is "mzr_locations".

Status Code

200
Success.
500
Internal server error. Your request cannot be processed. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Get the list of available hardware templates as a JSON object, and the key name is "templates".

GET /v2/templates

Request

Custom Headers

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

Query Parameters

location
string
Optional. The default value is all locations.
tag
string
The specific tag to view customer specific templates.

Allowable values: [att,hourly]

Example request

curl -X GET   https://api.vmware-solutions.cloud.ibm.com/v2/templates?tag=hourly   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'

Response

Response Body

def_templates

The list of available hardware templates in JSON format.

Status Code

200
Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported server types per location or vSphere version as a JSON object. The key name is the given location value or the vSphere version value. If no location or vSphere version is given, the key name is "server_types”.

GET /v2/server_types

Request

Custom Headers

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

Query Parameters

location
string
Optional. The default value is all locations.
vsphere_version
string
Optional. The default value is all supported vSphere versions.

Example request

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

Response

Response Body

def_server_types

The list of supported server CPU types in JSON format.

Status Code

200
Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported RAM types as a JSON object, and the key name is "ram_types".

GET /v2/ram_types

Request

Custom Headers

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

Example request

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

Response

Response Body

def_ram_types

The list of supported RAM types in JSON format.

Status Code

200
Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported disk types as a JSON object, and the key name is "disk_types".

GET /v2/disk_types

Request

Custom Headers

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

Example request

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

Response

Response Body

def_disk_types

The list of supported disk types in JSON format.

Status Code

200
Success.

No Sample Response

This method does not specify any sample responses.

The list of supported configuration options in JSON format.

GET /v2/supported_config_options

Request

Custom Headers

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

Example request

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

Response

Response Body

supported_config_options

The list of supported Config options.

Status Code

200
Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported shared storage tiers as a JSON object, and the key name is "shared_storage_tiers".

GET /v2/shared_storage_tiers

Request

Custom Headers

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

Example request

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

Response

Response Body

def_shared_storage_tiers

The list of supported shared storage tiers in JSON format.

Status Code

200
Success.

No Sample Response

This method does not specify any sample responses.

Get the list of supported vSphere versions as a JSON object, and the key name is "vsphere_versions".

GET /v2/vsphere_versions

Request

Custom Headers

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

Example request

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

Response

Response Body

def_vsphere_versions

The list of supported vSphere versions in JSON format.

Status Code

200
Success.

No Sample Response

This method does not specify any sample responses.

Retrieve the existing network from a specified datacenter.

GET /v2/existing_network

Request

Custom Headers

Authorization
Required*
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

datacenter
Required*
string
Datacenter ID. Use /v1/locations to find datacenter ID. Example dal10.

Response

Response Body

def_array_vlans

The list of VLANs that the instance exposes in JSON format.

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Get the list of all available service offerings.

GET /v1/service_catalog

Request

Custom Headers

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

Example request (Use quotation marks for URL with parameters)

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

Response

Response Body

service_catalog

Status Code

200
Success.
500
Internal server error. Your request cannot be processed. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Retrieve the detailed information on the service, including the set of necessary input fields, and their available options, for ordering the service, the service name, and an explanation of the service

GET /v1/service_catalog/{service_id}

Request

Custom Headers

Authorization
Required*
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

service_id
Required*
string
Service catalog ID.

Example request (Use quotation marks for URL with parameters)

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

Response

Response Body

service_catalog_details

Status Code

200
Success.
500
Internal server error. Your request cannot be processed. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

List all the services on a specified vCenter Server instance.

GET /v1/vcenters/{instance_id}/service_instances

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.

Query Parameters

installed_only
boolean
If set to true, services with REMOVED state will be excluded. Otherwise, services with INSTALLED, INSTALLING, REMOVING, REMOVED, and FAILEDVALIDATION states will be returned.

Default: true

Example request (Use quotation marks for URL with parameters)

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

Response

Response Body

service_instances

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Add service or services for a specified vCenter Server instance, verify the order, and check the price

POST /v1/vcenters/{instance_id}/service_instances

Request

Custom Headers

Authorization
Required*
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
Required*
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

Required*

service_order_data

Service order specification.

Example request (Use quotation marks for URL with parameters)

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/<instance_id>/service_instances?verify_only=false&check_price=true'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "services": [
      {
        "service_info": {
          "service_id": "vSRX",
          "variables": {
            "nickname": "test-auto",
            "vsrx_license_type": "Standard Edition",
            "target_cluster": "0"
            }
          }
        }
      ]
    }'

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request for adding the new service 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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

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

GET /v1/vcenters/{instance_id}/service_instances/{service_instance_id}

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
service_instance_id
Required*
string
Service Instance ID.

Example request (Use quotation marks for URL with parameters)

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

Response

Response Body

service_instance

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Deletes the specified service instance installed on the vCenter Server instance by the instance ID of the service.

DELETE /v1/vcenters/{instance_id}/service_instances/{service_instance_id}

Request

Custom Headers

Authorization
Required*
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
Required*
string
Instance ID.
service_instance_id
Required*
string
Service Instance ID.

Example request

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

Response

Status Code

202
Delete of service instance initiated successfully
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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Add, modify, or delete the variables of a service instance.

PATCH /v1/service_instances/{service_instance_id}/service_variables

Request

Custom Headers

Authorization
Required*
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

service_instance_id
Required*
string
Service Instance ID.

Request Body

Required*

object

The list of variables to be updated or deleted for a service instance.

Example request for variable update

curl -X PATCH   'https://api.vmware-solutions.cloud.ibm.com/v1/service_instances/<service_instance_id>/service_variables'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
  -d '{
    "action": "update",
    "variables": [
      {
        "name": "<variable_name_1>",
        "value": "<string_formatted_content_value>"
      },
      {
        "name": "<variable_name_2>",
        "value": {
          "<sub_variable_name_1>": "<string_formatted_sub_variable_value>",
          "<sub_variable_name_2>": {
            "<nested_sub_variable_name_2_1>": "<string_formatted_sub_variable_value>"
          }
        }
      }
    ]
  }'

Example request for variable deletion

curl -X PATCH   'https://api.vmware-solutions.cloud.ibm.com/v1/service_instances/<service_instance_id>/service_variables'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
  -d '{
    "action": "delete",
    "variables": [
      {
        "name": "<variable_name_1>"
      },
      {
        "name": "<variable_name_2>",
        "item_ids": [
          "<item_1_id>",
          "<item_2_id>"
        ]
      }
    ]
  }'

Response

Response Body

object

Status Code

202
Success. The request for updating or deleting the specified service variables 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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

List all stand-alone services on a specified service catalog id.

GET /v1/service_instances

Request

Custom Headers

Authorization
Required*
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

service_catalog_id
Required*
string
Service Catalog ID.
installed_only
boolean
If set to true, services with REMOVED state will be excluded. Otherwise, services with INSTALLED, INSTALLING, REMOVING, REMOVED, and FAILEDVALIDATION states will be returned.

Default: true

Example request for KMIP adapter service listing

curl   'https://api.vmware-solutions.cloud.ibm.com/v1/service_instances?service_catalog_id=KMIPAdapter'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'

Response

Response Body

service_instances

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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Add stand-alone services, verify order, or check price

POST /v1/service_instances

Request

Custom Headers

Authorization
Required*
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

Required*

service_order_data

Service order specification.

Example request for KMIP adapter service creation

curl -X POST   'https://api.vmware-solutions.cloud.ibm.com/v1/service_instances'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "services": [
      {
        "service_info": {
          "service_id": "KMIPAdapter",
          "instance_name": "kmip-exam"
          }
        }
      ]
    }'

Response

Status Code

200
Success. The request has been successfully verified.
202
Success. The request for adding the new service 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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Configure stand-alone services

PATCH /v1/service_instances

Request

Custom Headers

Authorization
Required*
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.

Request Body

Required*

service_configure_data

Service instance data to be configured.

Example request for KMIP adapter service configuration

curl -X PATCH   'https://api.vmware-solutions.cloud.ibm.com/v1/service_instances'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
      "services": [
          {
              "service_instance_id": "<KMIP_Adapter_service_instance_id>",
              "service_id": "KMIPAdapter",
              "variables": {
                  "Service_ID_Apikey": "<service_id_apikey_to_access_key_protect_or_HPCS_service>",
                  "KP_Service_Instance": "<key_protect_or_HPCS_service_instance_metadata_with_format (region_id):(kp_or_HPCS_service_instance_id):(kp_or_HPCS_service_instance_name):(base64_encoded_kp_or_hpcs_service_endpoint)>",
                  "Customer_Root_Key": "<root_key_created_within_key_protect_or_HPCS_service_instance_as_CRK>",
                  "Account_Vrf_Mis_Enabled": true
              }
          }
      ]
    }'

Response

Status Code

200
The request for configuring the service 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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Retrieve the detailed information of a specified standalone service.

GET /v1/service_instances/{service_instance_id}

Request

Custom Headers

Authorization
Required*
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

service_instance_id
Required*
string
Service Instance ID.

Example request for KMIP adapter service retrieval

curl   'https://api.vmware-solutions.cloud.ibm.com/v1/service_instances/<kmip_adapter_service_instance_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'

Response

Response Body

service_instance

Status Code

200
Success.
400
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run ibmcloud login and then ibmcloud iam oauth-tokens.
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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Deletes the stand-alone service instance specified by service instance ID

DELETE /v1/service_instances/{service_instance_id}

Request

Custom Headers

Authorization
Required*
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

service_instance_id
Required*
string
Service Instance ID.

Example request for KMIP adapter service removal

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

Response

Status Code

202
Delete of service instance initiated successfully
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. Wait a few minutes and try again.

No Sample Response

This method does not specify any sample responses.

Introduction

Endpoint URLs

Authentication

Auditing

Error handling

Methods

Set the IBM Cloud infrastructure account user ID and API key for linked IBM Cloud account

Request

Custom Headers

Authorization

x-global-transaction-id

Query Parameters

retrieve_only

Request Body

infra_credentials

Response

Response Body

account_name

infra_credentials

Status Code

200

400

No Sample Response

Order a new vCenter Server (NSX-V) instance or verify the order

Request

Custom Headers

Authorization

x-global-transaction-id

Query Parameters

verify_only

check_price

Request Body

name

location

root_domain

hardware

host_prefix

subdomain

domain_type

dns_type

vsphere_version

resource_group

large_chassis_only

network

shared_storages

license_keys

vcenter

nsx

vsphere

vsan

default_cluster_name

hourly

networking

services

Response

Status Code

200

202

400

401

403

500

No Sample Response

Order a new vCenter Server (NSX-V) instance with an edge gateway cluster or verify the order

Request

Custom Headers

Authorization

x-global-transaction-id

Query Parameters

verify_only

check_price

Request Body

name

root_domain

management

edge

license_keys

vcenter

nsx

vsphere