[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
Get Registration
DescriptionRetrieves information on the current state of a specified Usage Meter agent registration and the associated commit contract in Commerce Portal.
Request
URLURL
https://console.navigator.vmware.com/usage/api/v1/agent-registrations/{agentId}
Path Parameters
Path Parameters
string
agentId
Required
The ID of the Usage Meter agent.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
Registration
of type application/json
The contract number associated with the agent and the site name if there is any, otherwise the latter is omitted.
{
"contractNumber": "string",
"siteName": "string"
}
string
contractNumber
Required
The commit contract number as listed in Commerce Portal, against which a Usage Meter agent is registered.
string
siteName
Optional
The name of the commit contract site as set in Commerce Portal, against which the Usage Meter agent is registered.
202 Accepted
The Usage Meter agent registration process is still in progress. An “Agent-Registration-Progress” header provides the current state of the registration.
Operation doesn't return any data structure.
204 No Content
The Usage Meter agent is not associated with a contract (demo use case).
Operation doesn't return any data structure.
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl https://console.navigator.vmware.com/usage/api/v1/agent-registrations/{agentId}
[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
Usage Operations
get
post
