IBM Cloud for VMware Shared API V2

Introduction

Last updated: 2025-03-25

As of 28 March 2024, VMware Shared is not available for new deployments and support for existing instances ended on 28 February 2025. As of 4 March 2025, all VMs are powered off and on 6 April 2025, all customer and management data will be deleted. To avoid permanent deletion of your VMware Shared backups and to migrate your VMware Shared resources to VMware Cloud Foundation as a Service, open an IBM Support ticket by 6 April 2025. For more information, see End of Support for VMware Shared deployments.

With IBM Cloud® for VMware Solutions Shared, you can quickly and seamlessly migrate or deploy VMware workloads to the cloud on your professionally-managed VMware infrastructure. IBM provides a self-service VMware cloud computing platform with vCloud Director running on IBM Cloud. With this infrastructure-as-a-service (IaaS) pay-as-you-go offering, you can use vCPU, storage, RAM, networking, backup services, and operating system license rentals, as needed.

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

Microsoft terms

Endpoint URLs

The API is available at:

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

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 'iam_token: <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 IAM 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 service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method.

For more information about how to track VMware Solutions activity, see Activity tracking 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 about API operation failures, you can provide the x-global-transaction-id for better debugging.

Virtual data center access points are associated with all virtual data center instances in the same region and define the URL for access to the vCloud Director web UI and for API calls.

GET /locations

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Query Parameters

site_uuid
Required*
string
Site ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Response

Response Body

locations_spec

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
503
Service unavailable

Example responses

Status 200

{
  "locations": [
    {
      "enabled": true,
      "url": "https://sao01.director.com/tenant/UXN9G6",
      "value": "sao01"
    },
    {
      "enabled": false,
      "url": "https://dal10.director.com/tenant/UXN9G6",
      "value": "dal10"
    }
  ]
}
Copy to clipboard

The admin credentials are used for all VMware Shared instances located in a region. If you change the password of the admin account, the password is changed for all instances that are in that region.

PUT /locations/{location}/password

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

location
Required*
string
Datacenter short name

Example: sao01

Response

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
503
Service unavailable

Example responses

GET /locations/catalog

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Response

Response Body

location_catalog

Status Code

200
OK
400
Bad Request
401
Unauthorized
503
Service unavailable

Example responses

Status 200

{
  "catalog": [
    {
      "region": "nasouth",
      "value": "dal10",
      "default": true
    },
    {
      "region": "southamerica",
      "value": "sao01"
    }
  ]
}
Copy to clipboard

Services add capabilities to virtual data centers such as backup, compliance controls, and workload migration. The use of services can have additional costs.

GET /services/catalog

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Query Parameters

preconfigured_only
boolean
Return only services included with virtual data centers

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

{
  "service1": {
    "display_name": "Service 1, v0.0.1",
    "service_category": "Disaster Recovery",
    "description": "service description",
    "locations": [
      "location1",
      "location2",
      "location3"
    ]
  },
  "service2": {
    "display_name": "Service 2",
    "service_category": "A Service2 Manager",
    "description": "service description",
    "locations": [
      "location1"
    ]
  },
  "service3": {
    "display_name": "Service 3, v7.1",
    "service_category": "Service3 Storage",
    "description": "service description",
    "locations": [
      "location1",
      "location2"
    ]
  }
}
Copy to clipboard

Services add capabilities to sites such as backup, compliance controls, and workload migration. The use of services can have additional costs.

GET /sites/{site_uuid}/services

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

{
  "service1": {
    "display_name": "Service1",
    "status": "Creating",
    "uri": "/v2/sites/site_uuid1/services/site_service1"
  },
  "service2": {
    "display_name": "Service2",
    "status": "ReadyToUse",
    "uri": "/v2/sites/site_uuid1/services/site_service2"
  }
}
Copy to clipboard

Services add capabilities to sites such as backup, compliance controls, and workload migration. The use of services can have additional costs.

GET /sites/{site_uuid}/services/{service_uuid}

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835
service_uuid
Required*
string
The unique ID of the service

Example: 5b97c133-5aa2-321e-a568-m423bn903b1c

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

{
  "display_name": "Service2",
  "self_service_url": "https://vmware-solutions.cloud.ibm.com/123456",
  "self_service_access_description": "Use your management portal credentials to access the Veeam portal.",
  "status": "ReadyToUse",
  "details": {}
}
Copy to clipboard

Services add capabilities to virtual data centers such as backup, compliance controls, and workload migration. The use of services can have additional costs.

GET /sites/{site_uuid}/vdcs/{vdc_uuid}/services/{service_uuid}

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90
service_uuid
Required*
string
The unique ID of the service

Example: 5b97c133-5aa2-321e-a568-m423bn903b1c

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

{
  "display_name": "Service2",
  "self_service_url": "https://service1.vmware-solutions.cloud.ibm.com:2222/123456",
  "self_service_access_description": "Use your management portal credentials to access the Veeam Portal.",
  "status": "ReadyToUse",
  "details": {}
}
Copy to clipboard

Services add capabilities to virtual data centers such as backup, compliance controls, and workload migration. The use of services can have additional costs.

PUT /sites/{site_uuid}/vdcs/{vdc_uuid}/services/{service_uuid}

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90
service_uuid
Required*
string
The unique service ID

Example: 5b97c133-5aa2-321e-a568-m423bn903b1c

Request Body

Required*

zerto_service_spec

Body describing a service to modify

Response

Response Body

zerto_service_return

Status Code

202
Accepted
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
409
Conflict
410
Gone
500
Internal Server Error
503
Service unavailable

Example responses

Status 202

{
  "display_name": "Service2",
  "self_service_url": "https://service1.vmware-solutions.cloud.ibm.com:2222/123456",
  "self_service_access_description": "Use your management portal credentials to access the Veeam Portal.",
  "status": "ReadyToUse",
  "details": {}
}
Copy to clipboard

Services add capabilities to virtual data centers such as backup, compliance controls, and workload migration. The use of services can have additional costs.

DELETE /sites/{site_uuid}/vdcs/{vdc_uuid}/services/{service_uuid}

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90
service_uuid
Required*
string
The unique ID of the service

Example: private_network_endpoint_7e26f138-1e0c-4d6d-996b-d05f3343ab90

Response

Status Code

202
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
405
Bad Request
409
Service unavailable
410
Not Found
500
Internal Server Error

No Sample Response

This method does not specify any sample responses.

Services add capabilities to Sites such as backup, compliance controls, and workload migration. The use of services can have additional costs.

GET /sites/{site_uuid}/vdcs/{vdc_uuid}/services

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

{
  "service1": {
    "display_name": "Service1",
    "status": "Creating",
    "uri": "/v2/sites/site_uuid1/vdcs/vdc_uuid1/services/site_service1"
  },
  "service2": {
    "display_name": "Service2",
    "status": "ReadyToUse",
    "uri": "/v2/sites/site_uuid1/vdcs/vdc_uuid1/services/site_service2"
  }
}
Copy to clipboard

Services add capabilities to virtual data centers such as backup, compliance controls, and workload migration. The use of services can have additional costs.

POST /sites/{site_uuid}/vdcs/{vdc_uuid}/services

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Request Body

Required*

pne_service_spec

Body describing a service to create

Response

Response Body

pne_services

Status Code

202
Accepted
400
Bad Request
401
Unauthorized
404
Not Found
405
Bad Request
409
Service unavailable
410
Not Found
500
Internal Server Error
503
Service unavailable

Example responses

Status 202

{
  "service_type": "private_network_endpoint",
  "created_by": "a-user-name",
  "created_time": 1507646782,
  "ordered_by": "a-user-name",
  "ordered_time": 1507646782,
  "service_details": {
    "device_type": "dedicated_1g",
    "whitelisted_addresses": [
      "10.177.191.84",
      "10.175.190.06/32"
    ]
  },
  "status": "Creating",
  "uuid": "private_network_endpoint_448083af-a249-4271-96bf-9e4070"
}
Copy to clipboard

POST /services/price

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Request Body

Required*

service_price_spec

Body for obtaining a price estimate for a service

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
503
Service unavailable

Example responses

Status 200

[
  {
    "categories": [
      {
        "name": "Private Network Endpoint",
        "description": "Private Network Endpoint",
        "price": "1.00",
        "type": "service",
        "items": [
          {
            "count": 1,
            "description": "Multi-tenant",
            "name": "Multi-tenant",
            "unit": "mo",
            "price": "0.00"
          },
          {
            "count": 1,
            "description": "Dedicated 1G",
            "name": "Dedicated 1G",
            "unit": "mo",
            "price": "650.00"
          },
          {
            "count": 1,
            "description": "Dedicated 10G",
            "name": "Dedicated 10G",
            "unit": "GB",
            "price": "1859.50"
          }
        ]
      }
    ],
    "total_month": "2124.00"
  }
]
Copy to clipboard

A site is a virtual data center instance. Directors manage organizations and other resources.

GET /sites/{site_uuid}

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

{
  "name": "Site1",
  "status": "Created",
  "enabled": true,
  "site_uuid": "uuid1",
  "org_uuid": "uuid1",
  "instances": 5
}
Copy to clipboard

This endpoint is a GET to retrieve all sites where the account has deployed virtual data centers. It can be used to gather information about the organizations of an account.

GET /sites

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Query Parameters

vdc_details
boolean
Include details about the virtual data centers of a site.

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

[
  {
    "name": "Site 1",
    "status": "Created",
    "enabled": true,
    "site_uuid": "uuid1",
    "org_uuid": "uuid1",
    "instances": 5,
    "vdcs": [
      {
        "name": "VDC 1",
        "status": "ReadyToUse",
        "uuid": "vdc_uuid_1"
      },
      {
        "name": "Site 2",
        "status": "ReadyToUse",
        "uuid": "vdc_uuid_2"
      }
    ]
  },
  {
    "name": "Site 2",
    "status": "Created",
    "enabled": true,
    "site_uuid": "uuid2",
    "org_uuid": "uuid2",
    "instances": 8,
    "vdcs": [
      {
        "name": "VDC 3",
        "status": "ReadyToUse",
        "uuid": "vdc_uuid_3"
      },
      {
        "name": "Site 4",
        "status": "ReadyToUse",
        "uuid": "vdc_uuid_4"
      }
    ]
  }
]
Copy to clipboard

This endpoint is a GET to retrieve all sites where the account can deploy virtual data centers. It can be used to gather information about the available locations of an account.

GET /sites/catalog

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Query Parameters

location_details
boolean
Include details about the locations of a site. This includes the location objects rather than only the location values.

Response

Response Body

object

Status Code

Example responses

Status 200

[
  {
    "name": "Site 1",
    "status": "Created",
    "enabled": true,
    "site_uuid": "uuid1",
    "org_uuid": "uuid1",
    "locations": [
      {
        "value": "dal10",
        "region": "Dal",
        "url": "https://some-url.com",
        "vsan": true
      },
      {
        "value": "dal12",
        "region": "Dal",
        "url": "https://some-url.com",
        "vsan": true
      }
    ]
  },
  {
    "name": "Site 2",
    "status": "Created",
    "enabled": true,
    "site_uuid": "uuid2",
    "org_uuid": "uuid2",
    "locations": [
      "dal10",
      "dal12"
    ]
  }
]
Copy to clipboard

GET /sites/{site_uuid}/vdcs

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835

Response

Response Body

vdcs

Status Code

200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error

Example responses

Status 200

[
  {
    "allocation_model": "ondemand",
    "cpu": 10,
    "created_by": "a-user-name",
    "created_time": 1507646782,
    "crn": "crn:v1:public:vmware-solutions:global:a/my-account-8888:448083af-a249-4271-96bf-9e407ca9bb0c::",
    "instance_type": "vdc",
    "location_url": "https://dal10dir01.vmware-solutions.cloud.ibm.com",
    "location": "dal10",
    "name": "vdctest1",
    "ram": 256,
    "ordered_by": "a-user-name",
    "ordered_time": 1507646782,
    "network": "public_and_private",
    "public_ip": [
      "169.0.0.1",
      "169.0.0.2",
      "169.0.0.3",
      "169.0.0.4",
      "169.0.0.5"
    ],
    "status": "ReadyToUse",
    "uuid": "448083af-a249-4271-96bf-9e407ca9bb0c"
  }
]
Copy to clipboard

POST /sites/{site_uuid}/vdcs

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Request Body

Required*

vdc_spec

Body describing a virtual data center to create

Response

Response Body

Vdc

Status Code

202
Accepted
400
Bad Request
401
Unauthorized
503
Service unavailable

Example responses

Status 202

{
  "allocation_model": "ondemand",
  "cpu": 10,
  "created_by": "a-user-name",
  "created_time": 1507646782,
  "crn": "crn:v1:public:vmware-solutions:global:a/my-account-8888:448083af-a249-4271-96bf-9e407ca9bb0c::",
  "instance_type": "vdc",
  "location_url": "https://dal10dir01.vmware-solutions.cloud.ibm.com",
  "location": "dal10",
  "name": "vdctest1",
  "network": "public_and_private",
  "ram": 256,
  "ordered_by": "a-user-name",
  "ordered_time": 1507646782,
  "public_ip": [],
  "status": "Creating",
  "uuid": "448083af-a249-4271-96bf-9e407ca9bb0c"
}
Copy to clipboard

Status 400

[
  {
    "name": [
      "Name must be unique. my-vdc-name is in use."
    ],
    "cpu": [
      "vCPU must be in the range of 1-10 cores."
    ],
    "ram": [
      "RAM must be in the range of 1-80 GB."
    ]
  }
]
Copy to clipboard

GET /sites/{site_uuid}/vdcs/{vdc_uuid}

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Response

Response Body

Vdc

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found

Example responses

Status 200

{
  "allocation_model": "ondemand",
  "cpu": 10,
  "created_by": "a-user-name",
  "created_time": 1507646782,
  "crn": "crn:v1:public:vmware-solutions:global:a/my-account-8888:448083af-a249-4271-96bf-9e407ca9bb0c::",
  "instance_type": "vdc",
  "location_url": "https://dal10dir01.vmware-solutions.cloud.ibm.com",
  "location": "dal10",
  "name": "vdctest1",
  "network": "public_and_private",
  "ram": 256,
  "ordered_by": "a-user-name",
  "ordered_time": 1507646782,
  "public_ip": [
    "169.0.0.1",
    "169.0.0.2",
    "169.0.0.3",
    "169.0.0.4",
    "169.0.0.5"
  ],
  "status": "ReadyToUse",
  "uuid": "448083af-a249-4271-96bf-9e407ca9bb0c"
}
Copy to clipboard

PUT /sites/{site_uuid}/vdcs/{vdc_uuid}

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Request Body

Required*

object

Body for changing virtual data center resource reservations

Response

Status Code

202
Accepted
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
503
Service unavailable

No Sample Response

This method does not specify any sample responses.

DELETE /sites/{site_uuid}/vdcs/{vdc_uuid}

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Response

Status Code

202
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
503
Service unavailable

No Sample Response

This method does not specify any sample responses.

POST /vdcs/price

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Example: en-us

Request Body

Required*

Price

Body for obtaining a price estimate for a virtual data center order

Response

Response Body

object

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
503
Service unavailable

Example responses

Status 200

[
  {
    "categories": [
      {
        "name": "vcdbase",
        "description": "HA Edge Gateway, 5 public IP addresses",
        "price": "0.00",
        "type": "infrastructure"
      },
      {
        "name": "vcdresource",
        "unit": "cores",
        "description": "Resources",
        "price": "1.00",
        "type": "infrastructure",
        "items": [
          {
            "count": 3,
            "description": "CPU count: 3 cores",
            "name": "vCPU Limit",
            "unit": "cores",
            "price": "0.0089"
          },
          {
            "count": 30,
            "description": "RAM: 30 GB",
            "name": "RAM Limit",
            "unit": "GB",
            "price": "0.0107"
          },
          {
            "count": 1,
            "description": "Outbound Public Networking GBs",
            "name": "Outbound GBs",
            "unit": "GB",
            "price": "0.25"
          }
        ]
      },
      {
        "name": "vcdstorage",
        "description": "Storage",
        "price": "1.00",
        "type": "infrastructure",
        "items": [
          {
            "count": 1,
            "description": "0.25 IOPS/GB",
            "name": "0.25 IOPS/GB",
            "unit": "GB",
            "price": "0.06"
          },
          {
            "count": 1,
            "description": "2 IOPS/GB",
            "name": "2 IOPS/GB",
            "unit": "GB",
            "price": "0.16"
          },
          {
            "count": 1,
            "description": "4 IOPS/GB",
            "name": "4 IOPS/GB",
            "unit": "GB",
            "price": "0.20"
          },
          {
            "count": 1,
            "description": "10 IOPS/GB",
            "name": "10 IOPS/GB",
            "unit": "GB",
            "price": "0.58"
          }
        ]
      },
      {
        "name": "Operating Systems",
        "description": "Operating System Licenses",
        "price": "1.00",
        "type": "os",
        "items": [
          {
            "count": 1,
            "description": "Price of license per Windows VM",
            "name": "license per VM",
            "unit": "vcpu",
            "price": "99.95"
          },
          {
            "count": 1,
            "description": "Price of license per RHEL VM with 1-4 vcpu",
            "name": "license per VM",
            "unit": "vcpu",
            "price": "0.20"
          },
          {
            "count": 1,
            "description": "Price of license per RHEL VM with 4+",
            "name": "license per VM",
            "unit": "vcpu",
            "price": "0.20"
          }
        ]
      },
      {
        "name": "Veeam",
        "description": "Veeam backup",
        "price": "1.00",
        "type": "service",
        "items": [
          {
            "count": 1,
            "description": "Price of license per VM",
            "name": "license per VM",
            "unit": "mo",
            "price": "10.00"
          },
          {
            "count": 1,
            "description": "Price of block per GB",
            "name": "block storage",
            "unit": "GB",
            "price": "0.20"
          },
          {
            "count": 1,
            "description": "Price of cloud object storage per GB",
            "name": "cloud object storage",
            "unit": "GB",
            "price": "0.20"
          }
        ]
      }
    ]
  }
]
Copy to clipboard

POST /vdcs/pricing

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Request Body

Required*

pricings_spec

Body for obtaining prices for virtual data center offerings

Response

Status Code

200
OK
400
Bad Request
401
Unauthorized
503
Service unavailable

Example responses

Status 200

{
  "pricings": [
    {
      "plan_name": "On-Demand",
      "plan_uuid": "1e36726b-6d0a-463c-a997-b855e5ec5bd0",
      "pricing": {
        "account_type": "bss",
        "categories": [
          {
            "items": [
              {
                "count": 1,
                "description": "0.25 IOPs",
                "hourly": true,
                "name": "0.25 IOPs",
                "price": "0.06",
                "unit": "GB-hr"
              },
              {
                "count": 1,
                "description": "2 IOPs",
                "hourly": true,
                "name": "2 IOPs",
                "price": "0.16",
                "unit": "GB-hr"
              },
              {
                "count": 1,
                "description": "4 IOPs",
                "hourly": true,
                "name": "4 IOPs",
                "price": "0.20",
                "unit": "GB-hr"
              },
              {
                "count": 1,
                "description": "10 IOPs",
                "hourly": true,
                "name": "10 IOPs",
                "price": "0.58",
                "unit": "GB-hr"
              }
            ],
            "name": "Storage",
            "price": "0.00",
            "price_hourly": "1.00",
            "type": "Storage"
          },
          {
            "name": "Base",
            "price": "0.00",
            "price_hourly": "0.00",
            "type": "Base",
            "unit": "mo"
          },
          {
            "name": "vCPU",
            "price": "0.00",
            "price_hourly": "0.0089",
            "type": "vCPU",
            "unit": "hr"
          },
          {
            "name": "RAM",
            "price": "0.00",
            "price_hourly": "0.0107",
            "type": "RAM",
            "unit": "GB-hr"
          },
          {
            "name": "Public egress - bandwidth",
            "price": "0.25",
            "price_hourly": "0.00",
            "type": "Public egress - bandwidth",
            "unit": "GB"
          },
          {
            "name": "Windows license per vCPU",
            "price": "0.00",
            "price_hourly": "0.0193",
            "type": "Windows license per vCPU",
            "unit": "hr"
          },
          {
            "name": "Red Hat license for up to 4 vCPU",
            "price": "0.00",
            "price_hourly": "0.20",
            "type": "Red Hat license for up to 4 vCPU",
            "unit": "hr"
          },
          {
            "name": "Red Hat license for more than 4 vCPU",
            "price": "0.00",
            "price_hourly": "0.80",
            "type": "Red Hat license for more than 4 vCPU",
            "unit": "hr"
          },
          {
            "description": "You will be charged for this service at the organization level based on actual consumption.",
            "items": [
              {
                "count": 1,
                "description": "License per VM",
                "hourly": false,
                "name": "License per VM",
                "price": "10.00",
                "unit": "mo"
              },
              {
                "count": 1,
                "description": "Block Storage",
                "hourly": true,
                "name": "Block Storage",
                "price": "0.20",
                "unit": "GB-hr"
              },
              {
                "count": 1,
                "description": "Cloud Object Storage",
                "hourly": true,
                "name": "Cloud Object Storage",
                "price": "0.20",
                "unit": "GB-hr"
              }
            ],
            "name": "Veeam",
            "price": "10.00",
            "price_hourly": "0.40",
            "type": "Veeam"
          }
        ],
        "total_hour": "2.42",
        "total_month": "110.20"
      }
    },
    {
      "plan_name": "Reserved",
      "plan_uuid": "6a7565d8-5e0b-4974-9e6b-14c5b9bb14d3",
      "pricing": {
        "account_type": "bss",
        "categories": [
          {
            "items": [
              {
                "count": 1,
                "description": "0.25 IOPs",
                "hourly": true,
                "name": "0.25 IOPs",
                "price": "0.06",
                "unit": "GB-hr"
              },
              {
                "count": 1,
                "description": "2 IOPs",
                "hourly": true,
                "name": "2 IOPs",
                "price": "0.16",
                "unit": "GB-hr"
              },
              {
                "count": 1,
                "description": "4 IOPs",
                "hourly": true,
                "name": "4 IOPs",
                "price": "0.20",
                "unit": "GB-hr"
              },
              {
                "count": 1,
                "description": "10 IOPs",
                "hourly": true,
                "name": "10 IOPs",
                "price": "0.58",
                "unit": "GB-hr"
              }
            ],
            "name": "Storage",
            "price": "0.00",
            "price_hourly": "1.00",
            "type": "Storage"
          },
          {
            "name": "vCPU",
            "price": "5.21",
            "price_hourly": "0.00",
            "type": "vCPU",
            "unit": "mo"
          },
          {
            "name": "RAM",
            "price": "6.26",
            "price_hourly": "0.00",
            "type": "RAM",
            "unit": "GB-mo"
          },
          {
            "name": "Public egress - bandwidth",
            "price": "0.25",
            "price_hourly": "0.00",
            "type": "Public egress - bandwidth",
            "unit": "GB"
          },
          {
            "name": "Windows license per vCPU",
            "price": "0.00",
            "price_hourly": "0.0193",
            "type": "Windows license per vCPU",
            "unit": "hr"
          },
          {
            "name": "Red Hat license for up to 4 vCPU",
            "price": "0.00",
            "price_hourly": "0.20",
            "type": "Red Hat license for up to 4 vCPU",
            "unit": "hr"
          },
          {
            "name": "Red Hat license for more than 4 vCPU",
            "price": "0.00",
            "price_hourly": "0.80",
            "type": "Red Hat license for more than 4 vCPU",
            "unit": "hr"
          },
          {
            "description": "You will be charged for this service at the organization level based on actual consumption.",
            "items": [
              {
                "count": 1,
                "description": "License per VM",
                "hourly": false,
                "name": "License per VM",
                "price": "10.00",
                "unit": "mo"
              },
              {
                "count": 1,
                "description": "Block Storage",
                "hourly": true,
                "name": "Block Storage",
                "price": "0.20",
                "unit": "GB-hr"
              },
              {
                "count": 1,
                "description": "Cloud Object Storage",
                "hourly": true,
                "name": "Cloud Object Storage",
                "price": "0.20",
                "unit": "GB-hr"
              }
            ],
            "name": "Veeam",
            "price": "10.00",
            "price_hourly": "0.40",
            "type": "Veeam"
          }
        ],
        "total_hour": "2.40",
        "total_month": "121.67"
      }
    }
  ]
}
Copy to clipboard

In an organization virtual data center we can have three different kind of networks: routed, direct and isolated.

GET /sites/{site_uuid}/vdcs/{vdc_uuid}/networks

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string
Used for requesting the response in a particular language

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835
vdc_uuid
Required*
string
Virtual data center ID

Example: 3e26f138-1e0c-4d6d-996b-d05f3343ab90

Response

Response Body

networks_spec

Status Code

200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

{
  "network1": {
    "gateway_cidr": [
      "192.168.1.1/24"
    ],
    "href": "https://sdaldir01.vmware-solutions.cloud.ibm.com/api/admin/network/f6404f5d-b28a-4d7a-bda7-5b900e056eb1",
    "id": "urn:vcloud:network:f6404f5d-b28a-4d7a-bda7-5b900e056eb1",
    "name": "Network 1"
  },
  "network2": {
    "gateway_cidr": [
      "192.168.8.1/24"
    ],
    "href": "https://sdaldir01.vmware-solutions.cloud.ibm.com/api/admin/network/79f67f02-045f-465a-8867-49a52f026d95",
    "id": "urn:vcloud:network:79f67f02-045f-465a-8867-49a52f026d95",
    "name": "Network 2"
  }
}
Copy to clipboard

GET /sites/{site_uuid}/oidc

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835

Response

Status Code

200
OK
202
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service unavailable

Example responses

{ "message": "OIDC is configured." }

Status 202

{
  "message": "OIDC configuration is already in progress."
}

POST /sites/{site_uuid}/oidc

Request

Custom Headers

iam_token
Required*
string
IBM Cloud IAM Bearer Token
Accept-Language
string

Path Parameters

site_uuid
Required*
string
Site ID

Example: 02bc424a-d40d-4ce8-bf56-e11801c24835

Response

Status Code

200
OK
202
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service unavailable

Example responses

Status 200

{
  "message": "To reset the IAM integration, you must first delete both your OpenID Connect (OIDC) settings and all imported OIDC type users."
}

Status 202

{
  "message": "Successfully submitted task to set OIDC."
}

Introduction

Endpoint URLs

Authentication

Auditing

Error handling

Methods

Get the list of virtual data center tenant access points

Request

Custom Headers

iam_token

Accept-Language

Query Parameters

site_uuid

Response

Response Body

locations

Status Code

200

400

401

403

503

Reset the vCloud Director organization password for the admin user

Request

Custom Headers

iam_token

Accept-Language

Path Parameters

location

Response

Status Code

200

400

401

403

503

Get the list of global data center locations where virtual data centers can be deployed

Request

Custom Headers

iam_token

Accept-Language

Response

Response Body

catalog

Status Code

200

400

401

503

Get the list of services included with virtual data centers

Request

Custom Headers

iam_token

Accept-Language

Query Parameters

preconfigured_only

Response

Response Body

any property

Status Code

200

400

401

500

503

Return services enabled for the specified site

Request

Custom Headers

iam_token

Accept-Language

Path Parameters

site_uuid

Response

Response Body

any property

Status Code

200

400

401

403