Patch Agent

Patch Agent

Update the attributes of a Usage Meter agent. If an agent is in deleted state it can be undeleted by invoking this operation with empty object body '{}' - update spec with no attributes.

Request
URI
PATCH
https://eapi.broadcom.com/vcf/ums/api/v2/{tenantId}/agents/{agentId}
COPY
Path Parameters
string
tenantId
Required

used to specify the ID of the tenant

string
agentId
Required

the ID of the agent

Request Body

new attributes for the agent

UpdateSpec of type(s) application/json
Required 
{
    "label": "string",
    "agentSequence": 0
}
string
label
Optional
Constraints: minLength: 1 maxLength: 512

the new label

integer As int64 As int64
agentSequence
Optional

the agent sequence. Used for optimistic locking. When updating or deleting an object one must provide the sequence number that it last used to view the state. When conflicts occur, client will get HTTP 412 precondition failed status code, and must either abort or obtain the new state of the object and retry.

Authentication
This operation uses the following authentication methods.
Responses
200

the complete new state of the agent

Returns ReactivatedAgent of type(s) application/json 
"ReactivatedAgent Object"
string As uuid As uuid
agentId
Required

agentId

string
label
Required
Constraints: minLength: 1 maxLength: 512

human-readable label of the agent

string As date-time As date-time
modifiedAt
Required

when was the record modified

string
version
Required

the Version of the agent

string As date-time As date-time
effectiveFrom
Required

when will the settings take effect

string
changedBy
Required

the name of the account that did the change

integer As int64 As int64
agentSequence
Required

agentSequence

string As uuid As uuid
tenantId
Required

tenantId

string
accessToken
Optional

The access token that must be used during appliance configuration.

boolean
deleted
Required

deleted


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Usage Management Operations
GET
Get Agents
POST
Post Agent
PATCH
Move Agents
GET
Get Agent
DELETE
Delete Agent
PATCH
Patch Agent
GET
Get Agent Oauth App
POST
Post Agent Oauth App
DELETE
Delete Agent Oauth App