Introduction
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 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)
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.
Note: To successfully invoke an API, the endpoint URL must be qualified with a method and authentication credential via IAM token in the request header.
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.
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.
Event tracking
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 Shared activity, see Auditing events for VMware Solutions.
Methods
Set the IBM Cloud infrastructure account user ID and API key for linked IBM Cloud account
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Query Parameters
Whether to only retrieve the IBM Cloud infrastructure API user information.
Default:
false
The IBM Cloud infrastructure account information. The provided IBM Cloud infrastructure account ID should be consistent with the provided user name and API key.
IBM Cloud infrastructure API credentials
Response
IBM Cloud account name
IBM Cloud infrastructure API credentials
Status Code
Success. The request has been successfully performed.
Bad request. Check your request parameters.
No Sample Response
Retrieve the existing network in a data center
Retrieve the existing network from a specified data center.
GET /v1/existing_network
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Query Parameters
Data center ID. Use /v1/locations to find the data center ID. For example,
dal13
.
Response
List of existing VLANs for a data center.
Internal identifier (ID) of the VLAN. For example,
1234567
.Pod name.
Example:
sjc03.pod02
List of primary subnets in the specified existing VLAN.
VLAN private or public type.
List of primary subnets in the specified existing VLAN.
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Get the list of supported data center locations as a JSON object
Get the list of supported data center locations as a JSON object, and the key name is "locations".
GET /v2/locations
Request
Custom Headers
Global transaction ID for request correlation.
Response
Available data center locations in JSON format. The key name is "locations".
The list of available data center locations
The data center ID
The geography of the data center.
The region of the data center.
locations
Status Code
Success.
No Sample Response
Get the list of supported data center locations as a JSON object
Get the list of supported data center locations as a JSON object, and the key name is "mzr_locations".
GET /v2/mzr_locations
Request
Custom Headers
Global transaction ID for request correlation.
Response
The list of available Multi-Zone Region data center locations in JSON format. The key name is "mzr_locations".
The list of available Multi-Zone Region data center locations.
The Multi-Zone Region data center ID.
The geography of the Multi-Zone Region data center.
The region of the Multi-Zone Region data center.
The Multi-Zone Region location.
mzr_locations
Status Code
Success.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Get the list of available hardware templates as a JSON object
Get the list of available hardware templates as a JSON object, and the key name is "templates".
GET /v2/templates
Request
Custom Headers
Global transaction ID for request correlation.
Query Parameters
The specific tag to view customer specific templates.
Allowable values: [
att
,readynode
,hourly
]
Response
The list of available hardware templates in JSON format.
The list of available hardware templates.
The hardware template ID.
The description of the hardware template.
templates
Status Code
Success.
No Sample Response
Get the list of supported server CPU types per location as a JSON object
Get the list of supported server types per location as a JSON object, and the key name is the given location value. If no location is given, the key name is "server_types"
GET /v2/server_types
Request
Custom Headers
Global transaction ID for request correlation.
Query Parameters
optional, default is all locations
Response
The list of supported server CPU types in JSON format.
The list of supported server CPU types.
The server CPU type ID.
The description of the server CPU type.
server_types
Status Code
Success.
No Sample Response
Get the list of supported RAM types as a JSON object
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
Global transaction ID for request correlation.
Response
The list of supported RAM types in JSON format.
The list of supported RAM types.
The RAM type ID.
The description of the RAM type.
The list of server CPU types on which the specified RAM type is supported.
ram_types
Status Code
Success.
No Sample Response
Get the list of supported disk types as a JSON object
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
Global transaction ID for request correlation.
Response
The list of supported disk types in JSON format.
The list of supported disk types.
The disk type ID.
The description of the disk type.
disk_types
Status Code
Success.
No Sample Response
Get the list of supported shared storage tiers as a JSON object
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
Global transaction ID for request correlation.
Response
The list of supported shared storage tiers in JSON format.
The list of supported shared storage tiers.
The type of the shared storage tier.
The size of the shared storage tier.
The description of the shared storage tier.
shared_storage_tiers
Status Code
Success.
No Sample Response
Get the list of supported vSphere versions as a JSON object
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
Global transaction ID for request correlation.
Response
The list of supported vSphere versions in JSON format.
The list of supported vSphere versions.
vSphere version.
vsphere_versions
Status Code
Success.
No Sample Response
Order a new vCenter Server instance or verify the order.
Order a new vCenter Server instance or verify the order with specified configurations.
POST /v1/vcenters
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Query Parameters
Whether to verify the order only instead of performing the order for real.
Default:
false
Whether to display the high-level price associated with the order.
Default:
false
Order specification with configurations.
New VMware instance name that must be unique in your account.
Constraints: length ≤ 10
Example:
myvmware
Data center location. To list available data center locations, use the
GET /v1/locations
API.Root domain of the VMware vSphere hosts.
Example:
mycompany.local
Hardware configuration of the vSphere servers.
Hostname prefix of the VMware vSphere hosts.
Default:
host
Example:
host
Subdomain of the VMware vSphere hosts.
Default:
same as `name`
Example:
myvmware
Domain type. "primary" is the only supported value currently.
Allowable values: [
primary
]Default:
primary
Active Directory DNS type. Valid values are "vsi" or "ha_vm".
Allowable values: [
vsi
,ha_vm
]Default:
vsi
vSphere version. To list supported vSphere versions, use the
GET /v1/vsphere_versions
API. Use "latest" to specify the latest supported vSphere version.Default:
latest
Example:
latest
Resource group ID. To list resource groups, see the Resource Manager API for IBM Cloud. By default, the default resource group ID in the account is used.
Example:
abcdefgba12e4c0fb69c3b09d1f12345
Network configuration.
List of shared storage configurations.
VMware license keys configuration.
vCenter license key configuration.
vCenter license key configuration.
vSphere license key configuration.
vCenter license key configuration.
license_keys
Name of the default cluster.
Constraints: length ≤ 30
Default:
cluster1
Example:
cluster1
Whether hosts should be billed hourly or monthly (default). Currently for AT&T only
Default:
false
Networking solution type. Use
vcs_nsx_t
to deploy a vCenter Server with NSX-T instance.Allowable values: [
vcs
,vcs_nsx_t
,vcs_edge
,vcs_nsx_t_trial
]Default:
vcs
existing network selections
list of services to be added on bringup.
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_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" } }, "services": [ { "service_info": { "service_id": "vSRX", "variables": { "nickname": "test-auto", "vsrx_license_type": "Standard Edition", "target_cluster": "mgmt" } } } ] }'
Response
Status Code
Success. The request has been successfully verified.
Success. The request for creating the vCenter Server instance has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Order a new vCenter Server instance with an edge services cluster or verify the order.
Order a new vCenter Server instance with edge services cluster or verify the order with specified configurations.
POST /v1/vcenters/edge
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Query Parameters
Whether to verify the order only instead of performing the order for real.
Default:
false
Whether to display the high-level price associated with the order.
Default:
false
Order specification with configurations.
New VMware instance name that must be unique in your account.
Constraints: length ≤ 10
Example:
myvmware
Root domain of the VMware vSphere hosts.
Example:
mycompany.local
Customized hardware configuration to be ordered.
Edge cluster configuration.
VMware license keys configuration.
vCenter license key configuration.
vCenter license key configuration.
vSphere license key configuration.
vCenter license key configuration.
license_keys
Hostname prefix of the VMware vSphere hosts.
Default:
host
Example:
host
Subdomain of the VMware vSphere hosts.
Default:
same as `name`
Example:
myvmware
Domain type. "primary" is the only supported value currently.
Allowable values: [
primary
]Default:
primary
Active Directory DNS type. Valid values are "vsi" or "ha_vm".
Allowable values: [
vsi
,ha_vm
]Default:
vsi
vSphere version. To list supported vSphere versions, use the
GET /v1/vsphere_versions
API. Use "latest" to specify the latest supported vSphere version.Default:
latest
Example:
latest
Networking solution type. Use
vcs_nsx_t
to deploy a vCenter Server with NSX-T instance.Allowable values: [
vcs
,vcs_nsx_t
,vcs_edge
,vcs_nsx_t_trial
]Default:
vcs
List of services to be added to the instance.
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": "mysubdomain", "root_domain": "mydomain.local", "vsphere_version": "6.7", "host_prefix": "host", "dns_type": "vsi", "license_keys": { "vcenter": { "key": "" }, "nsx": { "key": "", "license_type": "base" }, "vsphere": { "key": "" } }, "management": { "cluster_name": "my-management-cluster", "location": "wdc04", "template_id": "1", "customized_hardware": { "server": "INTEL_INTEL_XEON_4210_2_20", "ram": "RAM_192_GB_DDR4_2133_ECC_REG", "disks": [ "HARD_DRIVE_960GB_SSD_SED_5DWPD", "HARD_DRIVE_960GB_SSD_SED_5DWPD" ], "vsan_cache_disks": [ "HARD_DRIVE_NVME_750_GB_PCIE", "HARD_DRIVE_NVME_750_GB_PCIE" ], "vsan_compression": true }, "quantity": 4, "license_keys": { "vsan": { "key": "", "license_type": "advanced" } } }, "edge": { "location": "wdc04", "cluster_name": "my-edge-cluster", "quantity": 2, "customized_hardware": { "server": "2U_VMW_BARE_METAL_GATEWAY_10_GBPS", "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
Success. The request has been successfully verified.
Success. The request for creating the vCenter Server instance with NSX-T has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Order a new vCenter Server instance with NSX-T or verify the order.
Order a new vCenter Server instance with NSX-T or verify the order with specified configurations.
POST /v1/vcenters/nsxt
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Query Parameters
Whether to verify the order only instead of performing the order for real.
Default:
false
Whether to display the high-level price associated with the order.
Default:
false
Order specification with configurations.
New VMware instance name that must be unique in your account.
Constraints: length ≤ 10
Example:
myvmware
Root domain of the VMware vSphere hosts.
Example:
mycompany.local
Customized hardware configuration to be ordered.
VMware license keys configuration.
vCenter license key configuration.
vCenter license key configuration.
vSphere license key configuration.
vCenter license key configuration.
license_keys
Hostname prefix of the VMware vSphere hosts.
Default:
host
Example:
host
Subdomain of the VMware vSphere hosts.
Default:
same as `name`
Example:
myvmware
Domain type. "primary" is the only supported value currently.
Allowable values: [
primary
]Default:
primary
Active Directory DNS type. Valid values are "vsi" or "ha_vm".
Allowable values: [
vsi
,ha_vm
]Default:
vsi
vSphere version. To list supported vSphere versions, use the
GET /v1/vsphere_versions
API. Use "latest" to specify the latest supported vSphere version.Default:
latest
Example:
latest
Edge cluster configuration.
Networking solution type. Use
vcs_nsx_t
to deploy a vCenter Server with NSX-T instance.Allowable values: [
vcs
,vcs_nsx_t
,vcs_edge
,vcs_nsx_t_trial
]Default:
vcs
List of services to be added to the instance.
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 '{ "name": "my-nsxt", "dns_type": "vsi", "root_domain": "domain.local", "domain_type": "primary", "subdomain": "mysubdomain", "vcs_type": "vcs_nsx_t", "vsphere_version": "6.7", "host_prefix": "host", "license_keys": { "vsphere": { "key": "" }, "vcenter": { "key": "" }, "nsx": { "key": "", "license_type": "advanced" } }, "management": { "cluster_name": "my-management-cluster", "customized_hardware": { "server": "INTEL_INTEL_XEON_4210_2_20", "ram": "RAM_192_GB_DDR4_2133_ECC_REG" }, "template_id": "1", "shared_storages": [ { "quantity": 1, "volume": 1000, "iops": "READHEAVY_TIER", "size": "STORAGE_SPACE_FOR_2_IOPS_PER_GB" } ], "quantity": 3, "location": "dal12", "private_only": false }, "workload": { "cluster_name": "my-workload-cluster", "customized_hardware": { "server": "INTEL_INTEL_XEON_5218_2_30", "ram": "RAM_128_GB_DDR4_2133_ECC_REG" }, "template_id": "1", "shared_storages": [ { "quantity": 1, "volume": 1000, "iops": "READHEAVY_TIER", "size": "STORAGE_SPACE_FOR_2_IOPS_PER_GB" } ], "quantity": 2, "location": "dal12", "private_only": false }, "edge": { "location": "dal12", "cluster_name": "my-edge-cluster", "quantity": 2, "private_only": false, "customized_hardware": { "server": "2U_VMW_BARE_METAL_GATEWAY_10_GBPS", "ram": "RAM_64_GB_DDR4_2133_ECC_NON_REG" } }, "services": [ { "service_info": { "service_id": "vSRX", "variables": { "nickname": "myedge", "vsrx_license_type": "Standard Edition", "target_cluster": "edge" } } } ], }
Response
Status Code
Success. The request has been successfully verified.
Success. The request for creating the vCenter Server instance with NSX-T has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Order a new multi-zone stretched cluster instance or verify the order.
Order a new multi-zone stretched cluster instance or verify the order with specified configurations.
POST /v1/vcenters/mcv
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Query Parameters
Whether to verify the order only instead of performing the order for real.
Default:
false
Whether to display the high-level price associated with the order.
Default:
false
Order specification with configurations.
New VMware instance name that must be unique in your account.
Constraints: length ≤ 10
Example:
myvmware
MZR location. Choose one from ['Dallas', 'Washington', 'Sydney', 'Frankfurt', 'Tokyo', 'London']
Root domain of the VMware vSphere hosts.
Example:
mycompany.local
Management cluster configuration of the MCV.
Witness cluster configuration of the MCV.
Resource cluster configuration of the MCV.
Deployment type. Use
mcv
to deploy a VMware Mission Critical Workloads instance.Allowable values: [
mcv
,vcs
,vss
,stub
]Hostname prefix of the VMware vSphere hosts.
Default:
host
Example:
host
Subdomain of the VMware vSphere hosts.
Default:
same as `name`
Example:
myvmware
Domain type. "primary" is the only supported value currently.
Allowable values: [
primary
]Default:
primary
Active Directory DNS type. Valid values are "vsi" or "ha_vm".
Allowable values: [
vsi
,ha_vm
]Default:
vsi
vSphere version. To list supported vSphere versions, use the
GET /v1/vsphere_versions
API. Use "latest" to specify the latest supported vSphere version.Default:
latest
Example:
latest
VMware license keys configuration.
vCenter license key configuration.
vCenter license key configuration.
vSphere license key configuration.
vCenter license key configuration.
license_keys
curl -X POST 'https://api.vmware-solutions.cloud.ibm.com/v1/vcenters/mcv?verify_only=false&check_price=true' -H 'authorization: Bearer <IAM_token>' -H 'Content-Type:application/json' -d '{ "dns_type": "vsi", "license_keys": { "vsan": { "key": "", "license_type": "enterprise" }, "nsx": { "key": "", "license_type": "advanced" } }, "domain_type": "primary", "deploy_type": "mcv", "vsphere_version": "6.7", "mzr_location": "Washington", "name": "instance-name", "subdomain": "mysubdomain", "host_prefix": "host", "root_domain": "domain.local", "management": { "customized_hardware": { "server": "INTEL_INTEL_XEON_4210_2_20", "ram": "RAM_128_GB_DDR4_2133_ECC_REG" }, "template_id": "1", "shared_storages": [ { "iops": "READHEAVY_TIER", "quantity": 1, "volume": 1000, "size": "STORAGE_SPACE_FOR_2_IOPS_PER_GB" } ], "quantity": 2 }, "witness": { "customized_hardware": { "server": "INTEL_INTEL_XEON_4210_2_20", "ram": "RAM_128_GB_DDR4_2133_ECC_REG" }, "template_id": "1", "shared_storages": [ { "iops": "READHEAVY_TIER", "quantity": 1, "volume": 1000, "size": "STORAGE_SPACE_FOR_2_IOPS_PER_GB" } ], "quantity": 2, "witness_location": "wdc04" }, "resource": { "customized_hardware": { "server": "INTEL_INTEL_XEON_4210_2_20", "ram": "RAM_128_GB_DDR4_2133_ECC_REG", "disks": [ "HARD_DRIVE_960GB_SSD_SED_5DWPD", "HARD_DRIVE_960GB_SSD_SED_5DWPD" ], "vsan_cache_disks": [ "HARD_DRIVE_NVME_750_GB_PCIE", "HARD_DRIVE_NVME_750_GB_PCIE" ], "vsan_compression": true }, "template_id": "1", "quantity": 3 } }
Response
Status Code
Success. The request has been successfully verified.
Success. The request for creating the Multi-Zone Stretched Cluster instance has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Retrieve the detailed information of a vCenter Server instance.
Retrieve the detailed information of a vCenter Server instance.
GET /v1/vcenters/{instance_id}
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
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
Unique ID of the vCenter Server instance.
vCenter Server instance name.
Creator of the instance.
Creation timestamp in epoch.
Example:
1523282400
vCenter Server instance status.
Primary data center location of the instance.
Initial version of the instance.
Current version of the instance.
Domain types.
Possible values: [
primary
,secondary
]Root domain of the VMware vSphere hosts.
Hostname prefix of the VMware vSphere hosts.
Subdomain of the VMware vSphere hosts.
Cloud resource name. The unique resource identifier in IBM Cloud.
Example:
crn:v1:bluemix:public:vmware-solutions:global:a/account-abc:resource-abc::
Resource group ID. To list resource groups, see the Resource Manager API for IBM Cloud. By default, the default resource group ID in the account is used.
Example:
abcdefgba12e4c0fb69c3b09d1f12345
List of endpoints that the instance exposes.
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Delete a vCenter Server instance.
Delete a vCenter Server instance.
DELETE /v1/vcenters/{instance_id}
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
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
Success. The request for deleting the vCenter Server instance has been accepted.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Add a cluster for a specified vCenter Server instance or verify the order.
Add a cluster for a specified vCenter Server instance or verify the order.
POST /v1/vcenters/{instance_id}/clusters
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Query Parameters
Whether to verify the order only instead of performing the order for real.
Default:
false
Whether to display the high-level price associated with the order.
Default:
false
Cluster order specification with configurations.
New cluster name, which must be unique for the specified instance.
Constraints: length ≤ 30
Example:
mycluster
Data center location. To list available data center locations, use the
GET /v1/locations
API.Hardware configuration of the vSphere servers.
Whether the cluster should be placed into the default pod of the data center.
Network configuration.
List of shared storage configurations.
VMware license keys configuration.
vSphere license key configuration.
vCenter license key configuration.
license_keys
Whether hosts should be billed hourly or monthly (default)
Default:
false
Hostname prefix of the VMware vSphere hosts.
Default:
host
Example:
host
existing network selections
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": "myhost", "location": "sjc03", "license_keys": { "vsphere": { "key": "" } }, "hardware": { "quantity": 2, "customized_hardware": { "server": "INTEL_INTEL_XEON_4210_2_20", "ram": "RAM_64_GB_DDR4_2133_ECC_NON_REG" } }, "shared_storages": [ { "iops": "LOW_INTENSITY_TIER", "quantity": 1, "volume": 1000, "size": "STORAGE_SPACE_FOR_0_25_IOPS_PER_GB" } ] "is_default_pod": true, "network": { "private_only": false }, "networking": { "public_vlan": { "id": 1234567, "primary_subnet_id": 4567890 } } }'
Response
Status Code
Success. The request has been successfully verified.
Success. The request for adding the new cluster has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Retrieve the detailed information of a cluster.
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Cluster ID.
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
Unique ID of the cluster.
Cluster name.
Data center location of the cluster.
Whether the cluster is in the default pod of the data center.
Name of the specific pod in the data center.
Cluster status.
Number of hosts in the cluster.
Example:
2
List of hosts in the cluster.
List of shared storage datastores configurations.
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Delete a cluster
Delete a specified cluster from a specified vCenter Server instance.
DELETE /v1/vcenters/{instance_id}/clusters/{cluster_id}
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Cluster ID.
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
Success. The request for deleting the cluster has been accepted.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.
No Sample Response
Retrieve the existing network of a cluster.
Retrieve the existing network of a specified cluster.
GET /v1/vcenters/{instance_id}/clusters/{cluster_id}/existing_network
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Cluster ID.
Response
List of existing VLANs for a data center.
Internal identifier (ID) of the VLAN. For example,
1234567
.Pod name.
Example:
sjc03.pod02
List of primary subnets in the specified existing VLAN.
VLAN private or public type.
List of primary subnets in the specified existing VLAN.
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Add new hosts to a specified cluster.
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Cluster ID.
Query Parameters
Whether to verify the order only instead of performing the order for real.
Default:
false
Whether to display the high-level price associated with the order.
Default:
false
Parameters for adding new hosts.
Number of new hosts to be added.
Example:
2
The template ID that maps to a preconfigured hardware specification to be ordered. To see supported templates, use the
GET /v1/templates
API. To customize your hardware configuration, usecustomized_hardware
. This will be ignored ifcustomized_hardware
is also specified. If using hourly packages, this must be defined along with the hourly flagExample:
1186
Whether to put the new hosts into maintenance mode after they are added.
Default:
false
Whether hosts should be billed hourly or monthly (default)
Default:
false
The vSphere version for the host OS
Example:
6.7u2
Customized hardware configuration to be ordered.
existing network selections
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
Success. The request has been successfully verified.
Success. The request for adding new hosts has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Conflict. The request cannot be completed because of a conflict with the current state of the target resource.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Delete hosts from a specified cluster
Delete hosts from a specified cluster for a specified vCenter Server instance.
PATCH /v1/vcenters/{instance_id}/clusters/{cluster_id}/hosts
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Cluster ID.
Parameters for deleting hosts.
Action to be performed against the specified hosts. 'delete' is the only supported value.
Allowable values: [
delete
]List of host IDs to be deleted. Delete these specified hosts from a specified cluster.
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
Success. The request for deleting the specified hosts has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Conflict. The request cannot be completed because of a conflict with the current state of the target resource.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Add shared storages to a specified cluster
Add new shared storages to a specified cluster for a specified vCenter Server instance.
POST /v1/vcenters/{instance_id}/clusters/{cluster_id}/shared_storages
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Cluster ID.
Query Parameters
Whether to verify the order only instead of performing the order for real.
Default:
false
Parameters for adding new Network File System (NFS) storage.
A specified type of shared storage configuration.
IOPS tier. To see supported IOPS and size combinations, use the
GET /v1/shared_storage_tiers
API.Example:
READHEAVY_TIER
Size tier. To see supported IOPS and size combinations, use the
GET /v1/shared_storage_tiers
API.Example:
STORAGE_SPACE_FOR_2_IOPS_PER_GB
Volume size of each storage in GB. For 10 IOPS/GB tier, the volume size can be in the range 20 - 4000. For other tiers, the volume size can be in the range 20 - 24000.
Example:
2000
Number of storages of this type.
Example:
1
shared_storages
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
Success. The request has been successfully verified.
Success. The request for adding new NFS storage has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Conflict. The request cannot be completed because of a conflict with the current state of the target resource.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Delete NFS storages from a specified cluster
Delete Network File System (NFS) storages from a specified cluster for a specified vCenter Server instance.
PATCH /v1/vcenters/{instance_id}/clusters/{cluster_id}/shared_storages
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Cluster ID.
NFS storage ID list for deleting.
Action to be performed against the specified shared storages. 'delete' is the only supported value.
Allowable values: [
delete
]List of NFS storage IDs to be deleted. Delete these specified storages from a specified cluster.
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
Success. The request for deleting the specified nfs storage has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Conflict. The request cannot be completed because of a conflict with the current state of the target resource.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
List all vCenter Server instances as a JSON object
List all the vCenter Server instances that the user can access. The key name is "vcenters".
GET /v2/vcenters
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Response
The list of vCenters information in JSON format.
The detailed information of the vCenter Server instance.
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
List all history messages for a specified vCenter Server instance as a JSON object
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Query Parameters
The start date from 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.
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
history messages
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
List all the clusters for a specified vCenter Server instance as a JSON object
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Response
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Retrieve the detailed network interface of a cluster as a JSON object
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Cluster ID.
Response
The list of VLANs that the instance exposes in JSON format.
The list of VLANs that the instance exposes.
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Get list of available services
Get the list of all available service offerings.
GET /v1/service_catalog
Request
Custom Headers
Global transaction ID for request correlation.
curl -X GET 'https://api.vmware-solutions.cloud.ibm.com/v1/service_catalog' -H 'authorization: Bearer <IAM_token>' -H 'Content-Type:application/json'
Response
Status Code
Success.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Retrieve service information
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Service catalog ID.
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
The full name of a specified service.
The catalog ID of a specified service.
The detailed description of a service purpose, as displayed on the UI.
Latest service version.
Set of input variables and their available options for ordering a service.
Status Code
Success.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
List services on instance
List all the services on a specified vCenter Server instance.
GET /v1/vcenters/{instance_id}/service_instances
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Query Parameters
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
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
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Add services or verify order
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Query Parameters
Whether to verify the order only instead of performing the order for real.
Default:
false
Whether to display the high-level price associated with the order.
Default:
false
Service order specification.
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
Success. The request has been successfully verified.
Success. The request for adding the new service has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Retrieve specified service instance information on an instance
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Service Instance ID.
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
Unique ID of the service.
Service catalog ID.
Service full name.
vCenter Server instance name.
Service status.
Creation date and time.
Public variables for a service installation.
Status Code
Success.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Delete specified service instance on an instance
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
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Instance ID.
Service Instance ID.
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
Delete of service instance initiated successfully
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.
No Sample Response
Update or delete variables of service instance
Add, modify, or delete the variables of a service instance.
PATCH /v1/service_instances/{service_instance_id}/service_variables
Request
Custom Headers
Your IBM Cloud Identity and Access Management (IAM) token. To retrieve your IAM token, run
ibmcloud iam oauth-tokens
.Global transaction ID for request correlation.
Path Parameters
Service Instance ID.
The list of variables to be updated or deleted for a service instance.
The action to be performed against the specified variables of a service instance. The only supported values are 'update' and 'delete'.
Allowable values: [
update
,delete
]The list of variables requested to be updated or deleted for a service instance.
The name of the variable to be updated or deleted.
The sub-item IDs in the list or dictionary keys that need to be deleted.
The new values specified for the variables. The new values are in free-form JSON format, and they are used only when the performed action is 'update'.
variables
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>" } } } ] }'
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
The name list of the variables that were updated or removed.
The name of the variable that was updated or removed.
variables
Status Code
Success. The request for updating or deleting the specified service variables has been accepted.
Bad request. Check your request parameters.
Unauthorized. The IAM token is invalid or expired. To retrieve your IAM token, run
ibmcloud login
and thenibmcloud iam oauth-tokens
.Forbidden. Access to the specified resource is not authorized. Check the IAM access policy for the
VMware Solutions
service.Not found. The resource cannot be found.
Conflict. The request cannot be completed because of a conflict with the current state of the target resource.
Internal server error. Your request cannot be processed. Please wait a few minutes and try again.