[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator

Post Registration

Description

Initiates the registration task of a Usage Meter agent.

Request

Request

URL

URL


post
https://{api_host}/api/v1/agent-registrations
Copy

Request Body

Request Body

RegistrationSpec of mimetype application/json Required

the specification of the Usage Meter agent that will be registered

{
	"agentId": "string",
	"label": "string",
	"version": "string"
}
string as uuid
agentId Required

the ID of the Usage Meter agent


string
label Required

human readable label for the Usage Meter agent


string
version Required

the version of the Usage Meter agent


string
connectivityMode Optional

the ConnectivityMode of the Usage Meter agent

Possible values are: ONLINEOFFLINE


string
contractNumber Optional

the commit contract number as listed in Commerce Portal


string
meteringMode Optional

the MeteringMode of the Usage Meter agent

Possible values are: PRODUCTIONTEST


string
siteName Optional

the site name as set in Commerce Portal

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

201 Created

the Usage Meter agent is already registered. Its current state corresponds to the provided specification.


202 Accepted

the Usage Meter agent registration was initiated. The location header points to a status link, usually at /api/v1/agent-registrations/{agentId}.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"agentId":"string","connectivityMode":"ONLINE","contractNumber":"string","label":"string","meteringMode":"PRODUCTION","siteName":"string","version":"string"}' https://{api_host}/api/v1/agent-registrations


[{"label":"Latest (v1)","version":"latest"}]
cloud-partner-navigator
Feedback

Was this page helpful?