Post Agent

Post Agent

Register a Usage Meter agent.

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

used to specify the ID of the tenant

Request Body

the specification of the Usage Meter agent that will be registered.

RegistrationSpec of type(s) application/json
Required 
{
    "agentId": "string",
    "label": "string"
}
string As uuid As uuid
agentId
Required

the ID of the Usage Meter agent

string
label
Required

Human readable label for the agent

Authentication
This operation uses the following authentication methods.
Responses
200

Access token that should be used for Usage Meter activation

     <ul class="http-responses">
     <li>
     200 Agent registration was successful. The response body contains the
     generated access token.
     </li>
     <li>
     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.
     </li>
     <li>
     403 The user has no access to perform the requested operation.
     </li>
     </ul>
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/v2/{tenantId}/agents
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