Instance Key Endpoints #
Instance Key Activation #
PUT /instance-key
Activates an instance key.
Authentication required: yes
Permissions: instance-key-write
Query parameters: none
Request body:
{
"key": "JD1234567890qwertyuiopasdfghjklz"
}
key- string
The key of the instance. It must match the following regexp:^JD[a-zA-Z0-9]{30}$
Response body: none
Instance Key Retrieval #
GET /instance-key
Retrieves the active instance key.
Authentication required: yes
Permissions: instance-key-read
Query parameters: none
Request body: none
Response body:
{
"key": "JD1234567890qwertyuiopasdfghjklz"
}
key- string
The active key of the instance.
Instance Key Status Retrieval #
GET /instance-key/status
Retrieves the status of the instance key.
Authentication required: yes
Permissions: none
Query parameters: none
Request body: none
Response body:
{
"status": "valid"
}
status- string (enum)
The status of the instance key. Possible values:validinvalidmissing