Important
An access token must be generated to use this API.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
Header | Value |
---|---|
Authorization | Token {accessToken} |
Content-type | application/json |
Accept | application/json |
Parameters
All parameters are mandatory.
Field | Data Type | Description |
---|---|---|
activationKey | String | Activation token used to register the Gateway with the API server. |
opsRampServer | String | API 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 }