Get Registration Token Status

Get Registration Token Status
Get registration token status for the given token id.

Get registration token status for specified token id. The response for a successful get request contains the token status and registration manifest that can be used for registering baremetal servers.

Request
URI
GET
https://{api_host}/baremetal/registration-tokens/{token-id}/status
COPY
Path Parameters
string
token-id
Required

The registration token status.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TokenStatusInfo of type(s) application/json
{
    "id": "string",
    "display_name": "string",
    "description": "string",
    "allowed_instance_count": 0,
    "remaining_instance_count": 0,
    "status": "string",
    "expiration_timestamp": 0,
    "registration_manifest": "string"
}
string
id
Optional

The Id of the registration token generated by SSP in response to registration token request.

string
display_name
Optional
Constraints: minLength: 3 maxLength: 64

Registration token name.

string
description
Optional
Constraints: maxLength: 1024

Description of this token.

integer As int64 As int64
allowed_instance_count
Optional

Max Number of instances that can use this token.

integer As int64 As int64
remaining_instance_count
Optional

Number of remaining instances that can use this token.

string
status
Optional

The registration token status.

Possible values are : AVAILABLE, EXPIRED, USED,
integer As int64 As int64
expiration_timestamp
Optional

Timestamp in milliseconds since epoch.

string
registration_manifest
Optional

Registration token manifest.


default

Error response on API failure.

Returns Error of type(s) application/json
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/baremetal/registration-tokens/{token-id}/status