Patch Agent

Patch Agent

Update the attributes of an 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://console.cloud.vmware.com/commerce/usage-insight/api/usage-metering-agents/{agentId}
COPY
Path Parameters
string
agentId
Required

the ID of the agent

Request Body

new attributes for the agent

UpdateSpec of type(s) application/json
Required 
{
    "label": "string",
    "meteringMode": "string",
    "agentSequence": 0
}
string
label
Optional

the new label

string
meteringMode
Optional

the new MeteringMode of the agent

Possible values are : PRODUCTION, TEST,
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 UsageMeteringAgent of type(s) application/json 
{
    "agentId": "string",
    "organizationId": "string",
    "label": "string",
    "modifiedAt": "string",
    "meteringMode": "string",
    "version": "string",
    "connectivityMode": "string",
    "effectiveFrom": "string",
    "changedBy": "string",
    "agentSequence": 0,
    "deleted": false
}
string As uuid As uuid
agentId
Required

agentId

string As uuid As uuid
organizationId
Required

the ID of the organization to which this agent belongs to

string
label
Required

human-readable label of the agent

string As date-time As date-time
modifiedAt
Required

when was the record modified

string
meteringMode
Required

the MeteringMode of the agent

Possible values are : PRODUCTION, TEST,
string
version
Required

the Version of the agent

string
connectivityMode
Required

the ConnectivityMode of the agent

Possible values are : ONLINE, OFFLINE,
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

boolean
deleted
Required

deleted


On This Page
Usage Metering Agents Rest Operations Operations
DELETE
Delete Agent
GET
Get Agent
GET
Get Agents
PATCH
Patch Agent
POST
Post Agent