Organization
All operations require authentication.
List organizationsProduction
Returns the organizations, with their state and specification.
Query parameters
Filter resources on IAM tags
Headers
Pagination cursor
Pagination size
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the VMware Cloud Director organization
IAM resource metadata
Unique identifier
Reflects the readiness of the VMware Cloud Director organization. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Reads your token from $OVH_TOKEN
$ curl https:/[ { "currentState": { "apiUrl": "string", "billingType": "DEMO", "description": "string", "fullName": "string", "name": "string", "region": "ap-south-mum", "spla": true, "webInterfaceUrl": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "fullName": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]
List edge gateway tasksProduction
Returns the asynchronous tasks of the edge gateway.
Path parameters
Edge gateway ID
Organization ID
Virtual data center ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses edgeGatewayId = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]
List IP space tasksProduction
Returns the asynchronous tasks of the IP space.
Path parameters
Ip space ID
Organization ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses ipSpaceId = 00000000-0000-0000-0000-000000000000, organizationId = string
$ curl https:/[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]
List IP spacesProduction
Returns the IP spaces of the organization.
Path parameters
Organization ID
Headers
Pagination cursor
Pagination size
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization IP Space
Universal Unique identifier
Reflects the readiness of the organization IP Space resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGNew target specification for the VMware Cloud Director organization IP space
Date and time this resource was last modified
Example uses organizationId = string
$ curl https:/[ { "currentState": { "edgeGatewayId": "00000000-0000-0000-0000-000000000000", "internalScope": "192.0.2.0/24", "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "edgeGatewayId": "00000000-0000-0000-0000-000000000000", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]
List network ACLsAlpha
Returns the network access control lists of the organization.
Path parameters
Organization ID
Headers
Pagination cursor
Pagination size
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization network access control list resource
Unique identifier
Reflects the readiness of the organization network access control list resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses organizationId = string
$ curl https:/[ { "currentState": { "networks": [ { "name": "string", "network": "192.0.2.0/24" } ] }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "networks": [ { "name": "string", "network": "192.0.2.0/24" } ] }, "updatedAt": "2024-01-01T12:00:00Z" }]
List organization tasksProduction
Returns the asynchronous tasks of the organization.
Path parameters
Organization ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses organizationId = string
$ curl https:/[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]
List compute resourcesProduction
Returns the compute resources of the virtual datacenter.
Path parameters
Organization ID
Virtual data center ID
Headers
Pagination cursor
Pagination size
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter compute resource
Unique identifier
Reflects the readiness of the organization Virtual DataCenter compute resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGDate and time this resource was last modified
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/[ { "currentState": { "billingType": "DEMO", "memoryQuota": 0, "name": "string", "profile": "string", "vCPUCount": 0 }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "updatedAt": "2024-01-01T12:00:00Z" }]
List storage resourcesProduction
Returns the storage resources of the virtual datacenter.
Path parameters
Organization ID
Virtual data center ID
Headers
Pagination cursor
Pagination size
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter storage resource
Unique identifier
Reflects the readiness of the organization Virtual DataCenter storage resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGDate and time this resource was last modified
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/[ { "currentState": { "billingType": "DEMO", "capacity": 0, "name": "string", "profile": "string", "type": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "updatedAt": "2024-01-01T12:00:00Z" }]
List edge gatewaysProduction
Returns the edge gateways of the virtual datacenter.
Path parameters
Organization ID
Virtual data center ID
Headers
Pagination cursor
Pagination size
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter edge gateway
Universal Unique identifier
Reflects the readiness of the organization Virtual DataCenter edge gateway resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGNew target specification for the VMware Cloud Director organization edge gateway
Date and time this resource was last modified
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/[ { "currentState": { "deploymentMode": "ACTIVE_STANDBY", "idurn": "string", "name": "string", "providerGateway": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]
List virtual datacentersProduction
Returns the virtual datacenters of the organization.
Path parameters
Organization ID
Query parameters
Filter resources on IAM tags
Headers
Pagination cursor
Pagination size
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter
IAM resource metadata
Unique identifier
Reflects the readiness of the organization Virtual DataCenter. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses organizationId = string
$ curl https:/[ { "currentState": { "commercialRange": "NSX", "description": "string", "ipQuota": 0, "memoryQuota": 0, "name": "string", "region": "ap-south-mum", "storageQuota": 0, "vCPUCount": 0, "vCPUSpeed": 0, "vrack": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "vCPUSpeed": 0 }, "updatedAt": "2024-01-01T12:00:00Z" }]
List virtual datacenter tasksProduction
Returns the asynchronous tasks of the virtual datacenter.
Path parameters
Organization ID
Virtual data center ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]
List vRack segmentsAlpha
Returns the vRack segments of the virtual datacenter.
Path parameters
Organization ID
Virtual data center ID
Headers
Pagination cursor
Pagination size
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter vrack segment resource
Unique identifier
Reflects the readiness of the organization Virtual DataCenter vrack segment resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/[ { "currentState": { "mode": "NSX_EDGE_GATEWAY", "networks": [ "192.0.2.0/24" ], "type": "DEFAULT", "vlanId": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "mode": "NSX_EDGE_GATEWAY", "networks": [ "192.0.2.0/24" ], "vlanId": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]
List vRack segment tasksProduction
Returns the asynchronous tasks of the vRack segment.
Path parameters
Id
Organization ID
Virtual data center ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses id = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]
Get an organizationProduction
Returns the organization: name, region, billing type, API and web interface URLs, and requested specification.
Path parameters
Organization ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the VMware Cloud Director organization
IAM resource metadata
Unique identifier
Reflects the readiness of the VMware Cloud Director organization. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses organizationId = string
$ curl https:/{ "currentState": { "apiUrl": "string", "billingType": "DEMO", "description": "string", "fullName": "string", "name": "string", "region": "ap-south-mum", "spla": true, "webInterfaceUrl": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "fullName": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Get an IP spaceProduction
Returns the IP space: name, internal scope and associated edge gateway.
Path parameters
Ip space ID
Organization ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization IP Space
Universal Unique identifier
Reflects the readiness of the organization IP Space resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGNew target specification for the VMware Cloud Director organization IP space
Date and time this resource was last modified
Example uses ipSpaceId = 00000000-0000-0000-0000-000000000000, organizationId = string
$ curl https:/{ "currentState": { "edgeGatewayId": "00000000-0000-0000-0000-000000000000", "internalScope": "192.0.2.0/24", "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "edgeGatewayId": "00000000-0000-0000-0000-000000000000", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Get an IP space taskProduction
Returns the task: type, status, progress steps, errors and dates.
Path parameters
Ip space ID
Organization ID
Task ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses ipSpaceId = 00000000-0000-0000-0000-000000000000, organizationId = string, taskId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}
Get a network ACLAlpha
Returns the IP blocks allowed to reach the organization, as applied and as requested.
Path parameters
Id
Organization ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization network access control list resource
Unique identifier
Reflects the readiness of the organization network access control list resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses id = 00000000-0000-0000-0000-000000000000, organizationId = string
$ curl https:/{ "currentState": { "networks": [ { "name": "string", "network": "192.0.2.0/24" } ] }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "networks": [ { "name": "string", "network": "192.0.2.0/24" } ] }, "updatedAt": "2024-01-01T12:00:00Z"}
Get an organization taskProduction
Returns the task: type, status, progress steps, errors and dates.
Path parameters
Organization ID
Task ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses organizationId = string, taskId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}
Get a virtual datacenterProduction
Returns the virtual datacenter: commercial range, region, vCPU, memory, storage and IP quotas, and vRack.
Path parameters
Organization ID
Virtual data center ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter
IAM resource metadata
Unique identifier
Reflects the readiness of the organization Virtual DataCenter. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "commercialRange": "NSX", "description": "string", "ipQuota": 0, "memoryQuota": 0, "name": "string", "region": "ap-south-mum", "storageQuota": 0, "vCPUCount": 0, "vCPUSpeed": 0, "vrack": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "vCPUSpeed": 0 }, "updatedAt": "2024-01-01T12:00:00Z"}
Get an edge gateway taskProduction
Returns the task: type, status, progress steps, errors and dates.
Path parameters
Edge gateway ID
Organization ID
Task ID
Virtual data center ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses edgeGatewayId = 00000000-0000-0000-0000-000000000000, organizationId = string, taskId = 00000000-0000-0000-0000-000000000000, virtualDataCenterId = string
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}
Get a compute resourceProduction
Returns the compute resource: profile, vCPU count, memory quota and billing type.
Path parameters
Compute ID
Organization ID
Virtual data center ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter compute resource
Unique identifier
Reflects the readiness of the organization Virtual DataCenter compute resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGDate and time this resource was last modified
Example uses computeId = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "billingType": "DEMO", "memoryQuota": 0, "name": "string", "profile": "string", "vCPUCount": 0 }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "updatedAt": "2024-01-01T12:00:00Z"}
Get a storage resourceProduction
Returns the storage resource: profile, type, capacity and billing type.
Path parameters
Organization ID
Storage ID
Virtual data center ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter storage resource
Unique identifier
Reflects the readiness of the organization Virtual DataCenter storage resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGDate and time this resource was last modified
Example uses organizationId = string, storageId = 00000000-0000-0000-0000-000000000000, virtualDataCenterId = string
$ curl https:/{ "currentState": { "billingType": "DEMO", "capacity": 0, "name": "string", "profile": "string", "type": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "updatedAt": "2024-01-01T12:00:00Z"}
Get a virtual datacenter taskProduction
Returns the task: type, status, progress steps, errors and dates.
Path parameters
Organization ID
Task ID
Virtual data center ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses organizationId = string, taskId = 00000000-0000-0000-0000-000000000000, virtualDataCenterId = string
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}
Get a vRack segmentAlpha
Returns the vRack segment: VLAN ID, networks, connection mode and type.
Path parameters
Id
Organization ID
Virtual data center ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter vrack segment resource
Unique identifier
Reflects the readiness of the organization Virtual DataCenter vrack segment resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses id = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "mode": "NSX_EDGE_GATEWAY", "networks": [ "192.0.2.0/24" ], "type": "DEFAULT", "vlanId": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "mode": "NSX_EDGE_GATEWAY", "networks": [ "192.0.2.0/24" ], "vlanId": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Get an edge gatewayProduction
Returns the edge gateway: name, deployment mode, provider gateway and VMware Cloud Director ID.
Path parameters
Edge gateway ID
Organization ID
Virtual data center ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter edge gateway
Universal Unique identifier
Reflects the readiness of the organization Virtual DataCenter edge gateway resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGNew target specification for the VMware Cloud Director organization edge gateway
Date and time this resource was last modified
Example uses edgeGatewayId = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "deploymentMode": "ACTIVE_STANDBY", "idurn": "string", "name": "string", "providerGateway": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Get a vRack segment taskProduction
Returns the task: type, status, progress steps, errors and dates.
Path parameters
Id
Organization ID
Task ID
Virtual data center ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
Last update of the task
Example uses id = 00000000-0000-0000-0000-000000000000, organizationId = string, taskId = 00000000-0000-0000-0000-000000000000, virtualDataCenterId = string
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}
List regionsProduction
Returns the regions and the datacenters where resources can be deployed.
Headers
Pagination cursor
Pagination size
Response
Datacenter the resource runs in, which is where your data is stored
Asia Pacific (Australia - Sydney)Asia Pacific (Singapore -Singapore)Europe (France - Gravelines)Europe (France - Paris)Europe (France - Roubaix)Europe (France - Strasbourg)Europe (Germany - Limburg)Europe (Poland - Warsaw)Europe (United Kingdom - Erith)North America (Canada - East - Beauharnois)North America (US - East - Vinthill)North America (US - West - Hillsboro)Geographic area the datacenter belongs to, used to pick where to deploy
ap-south-mumap-southeast-sgpap-southeast-sydca-east-bhsca-east-toreu-central-waweu-west-erieu-west-graeu-west-limeu-west-pareu-west-rbxeu-west-sbgus-east-vaus-east-vinus-west-hilus-west-orReads your token from $OVH_TOKEN
$ curl https:/[ { "location": "Asia Pacific (Australia - Sydney)", "region": "ap-south-mum" }]
List orderable resourcesProduction
Returns the compute and storage profiles that can be ordered for the virtual datacenter, with their quotas, vCPU speed and IOPS per TB.
Path parameters
Organization ID
Virtual data center ID
Response
Available orderable compute resources to your organization Virtual DataCenter
Available orderable storage resources to your organization Virtual DataCenter
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/{ "compute": [ { "memoryQuota": 0, "name": "string", "profile": "string", "vCPUCount": 0, "vCPUSpeed": 0 } ], "storage": [ { "capacity": 0, "name": "string", "performanceClass": 0, "profile": "string", "type": "string" } ]}
Reset the administrator passwordProduction
Resets the password of the organization administrator. The new password is sent by email to the admin contact.
Path parameters
Organization ID
Response
Example uses organizationId = string
$ curl https:/Create an edge gatewayProduction
Creates an edge gateway in the virtual datacenter, with the name given in targetSpec.
Path parameters
Organization ID
Virtual data center ID
Request body (required)
New target specification for the VMware Cloud Director organization edge gateway
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter edge gateway
Universal Unique identifier
Reflects the readiness of the organization Virtual DataCenter edge gateway resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGNew target specification for the VMware Cloud Director organization edge gateway
Date and time this resource was last modified
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "deploymentMode": "ACTIVE_STANDBY", "idurn": "string", "name": "string", "providerGateway": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Delete an edge gatewayProduction
Deletes the edge gateway from the virtual datacenter.
Path parameters
Edge gateway ID
Organization ID
Virtual data center ID
Response
Example uses edgeGatewayId = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/Delete a storage resourceProduction
Deletes the storage resource from the virtual datacenter.
Path parameters
Organization ID
Storage ID
Virtual data center ID
Response
Example uses organizationId = string, storageId = 00000000-0000-0000-0000-000000000000, virtualDataCenterId = string
$ curl https:/Delete a compute resourceProduction
Deletes the compute resource from the virtual datacenter.
Path parameters
Compute ID
Organization ID
Virtual data center ID
Response
Example uses computeId = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/Delete a vRack segmentAlpha
Deletes the vRack segment from the virtual datacenter.
Path parameters
Id
Organization ID
Virtual data center ID
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter vrack segment resource
Unique identifier
Reflects the readiness of the organization Virtual DataCenter vrack segment resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses id = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "mode": "NSX_EDGE_GATEWAY", "networks": [ "192.0.2.0/24" ], "type": "DEFAULT", "vlanId": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "mode": "NSX_EDGE_GATEWAY", "networks": [ "192.0.2.0/24" ], "vlanId": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Update an organizationProduction
Updates the full name and description of the organization. Accepted only when the organization is READY, then applied asynchronously: currentState catches up with targetSpec.
Path parameters
Organization ID
Request body (required)
New target specification for the VMware Cloud Director organization
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the VMware Cloud Director organization
Unique identifier
Reflects the readiness of the VMware Cloud Director organization. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses organizationId = string
$ curl https:/{ "currentState": { "apiUrl": "string", "billingType": "DEMO", "description": "string", "fullName": "string", "name": "string", "region": "ap-south-mum", "spla": true, "webInterfaceUrl": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "string", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "fullName": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Update an IP spaceProduction
Renames the IP space or associates it with another edge gateway. Accepted only when the IP space is READY, then applied asynchronously: currentState catches up with targetSpec.
Path parameters
Ip space ID
Organization ID
Request body (required)
New target specification for the VMware Cloud Director organization IP Space
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization IP Space
Universal Unique identifier
Reflects the readiness of the organization IP Space resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGNew target specification for the VMware Cloud Director organization IP space
Date and time this resource was last modified
Example uses ipSpaceId = 00000000-0000-0000-0000-000000000000, organizationId = string
$ curl https:/{ "currentState": { "edgeGatewayId": "00000000-0000-0000-0000-000000000000", "internalScope": "192.0.2.0/24", "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "edgeGatewayId": "00000000-0000-0000-0000-000000000000", "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Replace network ACL rulesAlpha
Replaces the rules of the network access control list: each rule allows an IP block to reach the organization. A rule left out of the list is removed. Accepted only when the network ACL is READY, then applied asynchronously: currentState catches up with targetSpec.
Path parameters
Id
Organization ID
Request body (required)
New target specification for the organization network access control list
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization network access control list resource
Unique identifier
Reflects the readiness of the organization network access control list resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses id = 00000000-0000-0000-0000-000000000000, organizationId = string
$ curl https:/{ "currentState": { "networks": [ { "name": "string", "network": "192.0.2.0/24" } ] }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "networks": [ { "name": "string", "network": "192.0.2.0/24" } ] }, "updatedAt": "2024-01-01T12:00:00Z"}
Update a virtual datacenterProduction
Updates the description and the vCPU speed of the virtual datacenter. Accepted only when the virtual datacenter is READY, then applied asynchronously: currentState catches up with targetSpec.
Path parameters
Organization ID
Virtual data center ID
Request body (required)
New target specification for the organization Virtual DataCenter
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter
Unique identifier
Reflects the readiness of the organization Virtual DataCenter. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "commercialRange": "NSX", "description": "string", "ipQuota": 0, "memoryQuota": 0, "name": "string", "region": "ap-south-mum", "storageQuota": 0, "vCPUCount": 0, "vCPUSpeed": 0, "vrack": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "string", "resourceStatus": "CREATING", "targetSpec": { "description": "string", "vCPUSpeed": 0 }, "updatedAt": "2024-01-01T12:00:00Z"}
Update an edge gatewayProduction
Renames the edge gateway. Accepted only when the edge gateway is READY, then applied asynchronously: currentState catches up with targetSpec.
Path parameters
Edge gateway ID
Organization ID
Virtual data center ID
Request body (required)
New target specification of the Organization Virtual DataCenter edge gateway
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter edge gateway
Universal Unique identifier
Reflects the readiness of the organization Virtual DataCenter edge gateway resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGNew target specification for the VMware Cloud Director organization edge gateway
Date and time this resource was last modified
Example uses edgeGatewayId = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "deploymentMode": "ACTIVE_STANDBY", "idurn": "string", "name": "string", "providerGateway": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}
Update a vRack segmentAlpha
Updates the VLAN ID, the gateway networks in CIDR notation and the connection mode of the segment. Accepted only when the segment is READY, then applied asynchronously: currentState catches up with targetSpec.
Path parameters
Id
Organization ID
Virtual data center ID
Request body (required)
New target specification for the organization Virtual DataCenter vrack segment
Response
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the organization Virtual DataCenter vrack segment resource
Unique identifier
Reflects the readiness of the organization Virtual DataCenter vrack segment resource. A new target specification request will be accepted only in READY status.
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Date and time this resource was last modified
Example uses id = 00000000-0000-0000-0000-000000000000, organizationId = string, virtualDataCenterId = string
$ curl https:/{ "currentState": { "mode": "NSX_EDGE_GATEWAY", "networks": [ "192.0.2.0/24" ], "type": "DEFAULT", "vlanId": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "mode": "NSX_EDGE_GATEWAY", "networks": [ "192.0.2.0/24" ], "vlanId": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}