Post Agent

Post Agent

Register a usage metering agent.

Request
URI
POST
https://eapi.broadcom.com/vcf/ums/api/v1/usage-metering-agents
COPY
Request Body

the specification of the usage metering agent that will be registered

RegistrationSpec of type(s) application/json
Required

Show optional properties

{
    "agentId": "string",
    "label": "string"
}
{
    "agentId": "string",
    "label": "string",
    "meteringMode": "string"
}
string As uuid As uuid
agentId
Required

the ID of the usage metering agent

string
label
Required

Human readable label for the agent

string
meteringMode
Optional

the MeteringMode of the agent

Possible values are : PRODUCTION, TEST,
Authentication
This operation uses the following authentication methods.
Responses
200

Access token that should be used for usage meter activation

  • 200 Agent registration was successful. The response body contains the generated access token.
  • 201 Agent registration was successful, but no access token is generated that means OAuth app existed before registration and it needs to be revoked in order to obtain valid access token.
  • 403 The user has no access to perform the requested operation.
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"agentId:"string","label:"string"}' https://{api_host}/vcf/ums/api/v1/usage-metering-agents
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