Get Agent

Get Agent

Get all attributes for a usage metering agent.

Request
URI
GET
https://eapi.broadcom.com/vcf/ums/api/v1/usage-metering-agents/{agentId}
COPY
Path Parameters
string
agentId
Required

the ID of the agent

Authentication
This operation uses the following authentication methods.
Responses
200

the latest attributes for the agent

Returns UsageMeteringAgent of type(s) application/json 
{
    "agentId": "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
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
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


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vcf/ums/api/v1/usage-metering-agents/{agentId}
On This Page
Usage Metering Agents Operations
GET
Get Agents
POST
Post Agent
GET
Get Agent
PATCH
Patch Agent
DELETE
Delete Agent
GET
Get Agent O Auth App
POST
Post Agent O Auth App
DELETE
Delete Agent O Auth App