[{"label":"Latest (v1)","version":"latest"}]

cloud-partner-navigator

Post Registration

Description

Initiates the registration task of a Usage Meter agent.

Request

URL

post

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

Copy

Request Body

RegistrationSpec of mimetype application/json Required

the specification of the Usage Meter agent that will be registered

Show optional properties

{
	"agentId": "string",
	"label": "string",
	"version": "string"
}

{
	"agentId": "string",
	"connectivityMode": "ONLINE",
	"contractNumber": "string",
	"label": "string",
	"meteringMode": "PRODUCTION",
	"siteName": "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: ONLINE , OFFLINE

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: PRODUCTION , TEST

string

siteName Optional

the site name as set in Commerce Portal

Authentication

This operation uses the following authentication methods.

csp-auth-token

Response

201 Created

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

Operation doesn't return any data structure.

202 Accepted

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

Operation doesn't return any data structure.

No error details were provided in the OpenAPI specification.

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

Usage Operations

get

Get Registration

post

Post Registration

Post Registration

Request

URL

Request Body

Authentication

csp-auth-token

Response

201 Created

202 Accepted

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

On This Page

Usage Operations

Was this page helpful?