Register gateway

This endpoint is used to register the gateway.

Leave Feedback

URL

POST https://{gatewayIp}:port/api/v2/registration

Sample URLs

https://192.168.xx.xx:5480/api/v2/registration

cURL

curl -k -X POST https://{Gateway_IP}:5480/api/v2/registration -H 'Accept: application/json' -H 'Authorization: Token <TOKEN>' -H 'Content-Type: application/json' -k -d '{ "activationKey": "<key&>", "opsRampServer": "<OpsRampURL>"}'

Sample cURLs

curl -k -X POST https://192.168.xx.xx:5480/api/v2/registration -H ‘Accept: application/json’ -H ‘Authorization: Token e8e788658765be5f907cf29c60e23e6c6529296f’ -H ‘Content-Type: application/json’ -k -d ‘{ “activationKey”: “1a8ba0a0-791d-4a80-bc63-b6a7a09ffb84”, “opsRampServer”: “xxx.opsramp.com”}’

Header format

HeaderValue
AuthorizationToken {accessToken}
Content-typeapplication/json
Acceptapplication/json

Parameters

All parameters are mandatory.

FieldData TypeDescription
activationKeyStringActivation token used to register the Gateway with the API server.
opsRampServerStringAPI server to which Gateway wants to connect.

Status code

200 OK

Sample request

{
    "activationKey": "360541b2-3f4e-407d-b61a-3aa73c638ed2",
    "opsRampServer": "xxx.opsramp.com"
}

Sample response

{Appliance Registered Successfully }