[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]

vmware-cloud-director

Update Service

Description

Updates service specific metadata for a vRealize Orchestrator

Request

URL

put

https://{api_host}/cloudapi/vro/servers/{id}

Copy

Path Parameters

string

id Required

Request Body

VROServiceInfo of type(s) application/json Required

{
	"description": "string",
	"id": "string",
	"name": "string",
	"password": "string",
	"trustAnchor": "string",
	"username": "string",
	"vcId": {
		"id": "string",
		"name": "string"
	},
	"version": "string",
	"vroEndpoint": "string"
}

string

description Optional

string

id Optional

This is a read-only field in the client. Values set on this field will be ignored by the server.

string

name Optional

string as password

password Optional

The password is hidden using a Password Mask represented by a series of 6 asterisks ("******") in the response. The Password Mask is not an acceptable password during VRO Server registration. During an update, the Password Mask set for the ‘password’ field is interpreted as no change to the field and is ignored.

string

trustAnchor Optional

SSL Certificate chain for the VRO endpoint (deprecated)

string

username Optional

EntityReference

vcId Optional

Reference to the associated vCenter server.

string

version Optional

string as uri

vroEndpoint Optional

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Response

Response Body

200 OK

Returns VROServiceInfo of type(s) application/json;version=37.2

{
	"description": "string",
	"id": "string",
	"name": "string",
	"password": "string",
	"trustAnchor": "string",
	"username": "string",
	"vcId": {
		"id": "string",
		"name": "string"
	},
	"version": "string",
	"vroEndpoint": "string"
}

string

description Optional

string

id Optional

This is a read-only field in the client. Values set on this field will be ignored by the server.

string

name Optional

string as password

password Optional

string

trustAnchor Optional

SSL Certificate chain for the VRO endpoint (deprecated)

string

username Optional

EntityReference

vcId Optional

Reference to the associated vCenter server.

string

version Optional

string as uri

vroEndpoint Optional

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"description":"string","id":"string","name":"string","password":"string","trustAnchor":"string","username":"string","vcId":{"id":"string","name":"string"},"version":"string","vroEndpoint":"string"}' https://{api_host}/cloudapi/vro/servers/{id}

vmware-cloud-director

vRealize Orchestrator Operations

get

Get Registered vRO

patch

Patch Service

delete

Unregister

put

Update Service

Update Service

Request

URL

Path Parameters

Request Body

Authentication

ApiKeyAuth

Response

Response Body

200 OK

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

On This Page

vRealize Orchestrator Operations

Was this page helpful?