Patch Service

Patch Service

Updates service specific metadata for a vRealize Orchestrator

Request
URI
PATCH
https://{api_host}/cloudapi/vro/servers/{id}
COPY
Path Parameters
string
id
Required

id

string
id
Required

id

Request Body
VROServiceInfo of type(s) application/merge-patch+json
Required 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "vroEndpoint": "string",
    "username": "string",
    "password": "string",
    "version": "string",
    "trustAnchor": "string",
    "vcId": {
        "name": "string",
        "id": "string"
    }
}
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

name

string
description
Optional

description

string As uri As uri
vroEndpoint
Optional

vroEndpoint

string
username
Optional

username

string As password 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
version
Optional

version

string
trustAnchor
Optional

SSL Certificate chain for the VRO endpoint (deprecated)

EntityReference
vcId
Optional

vcId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VROServiceInfo of type(s) application/json;version=38.0 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "vroEndpoint": "string",
    "username": "string",
    "password": "string",
    "version": "string",
    "trustAnchor": "string",
    "vcId": {
        "name": "string",
        "id": "string"
    }
}
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

name

string
description
Optional

description

string As uri As uri
vroEndpoint
Optional

vroEndpoint

string
username
Optional

username

string As password 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
version
Optional

version

string
trustAnchor
Optional

SSL Certificate chain for the VRO endpoint (deprecated)

EntityReference
vcId
Optional

vcId


On This Page
V Realize Orchestrator Operations
GET
Get Registered VRO
PATCH
Patch Service
DELETE
Unregister
PUT
Update Service