Cloud Service Manager >
Cloud Types
Update the selection of CSM cloud types
Updates the list of desired clouds on cloud service manager
Request:
Method:
PUT
URI Path(s):
/api/v1/csm/desired-clouds
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CloudTypeConfigList
+
CloudTypeConfigList
(
schema
)
Name
Description
Type
Notes
_links
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
array of
ResourceLink
Readonly
_schema
Schema for this resource
string
Readonly
_self
Link to this resource
SelfResourceLink
Readonly
cloud_types
Cloud types list
array of
CloudTypeConfig
cursor
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
Readonly
result_count
Count of results found (across all pages), set only on first page
integer
Readonly
sort_ascending
If true, results are sorted in ascending order
boolean
Readonly
sort_by
Field by which records are sorted
string
Readonly
Example Request:
PUT https://<nsx-csm>/api/v1/csm/desired-clouds { "cloud_types": [ { "cloud_type": "aws" "enabled": true, } { "cloud_type": "azure", "enabled": true, } { "cloud_type": "aws-gov-us-east" "enabled": false, } { "cloud_type": "aws-gov-us-west", "enabled": false, } { "cloud_type": "azure-gov-us", "enabled": false, } ] }
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CloudTypeConfigList
+
CloudTypeConfigList
(
schema
)
Name
Description
Type
Notes
_links
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
array of
ResourceLink
Readonly
_schema
Schema for this resource
string
Readonly
_self
Link to this resource
SelfResourceLink
Readonly
cloud_types
Cloud types list
array of
CloudTypeConfig
cursor
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
Readonly
result_count
Count of results found (across all pages), set only on first page
integer
Readonly
sort_ascending
If true, results are sorted in ascending order
boolean
Readonly
sort_by
Field by which records are sorted
string
Readonly
Example Response:
{ "cloud_types": [ { "cloud_type": "aws" "enabled": true, } { "cloud_type": "azure", "enabled": true, } { "cloud_type": "aws-gov-us-east" "enabled": false, } { "cloud_type": "aws-gov-us-west", "enabled": false, } { "cloud_type": "azure-gov-us", "enabled": false, } ] }
Required Permissions:
crud
Feature:
cloud_accounts
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable