Create Registration Token

Generate a token for sensor registration

Allows generating a token with manifest info to register a sensor for a particular sensor group.

Request

URI

POST

https://{api_host}/sensors/registration-tokens

COPY

Request Body

Information for generating the token.

SensorRegistrationTokenInfo of type(s) application/json

Required

This request body class requires all of the following: InlineSensorRegistrationTokenInfo1

{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "allowed_instance_count": 0,
    "passphrase": "string",
    "device_type": "string",
    "status": "string",
    "registration_manifest": "string",
    "expiration": 0,
    "usage_count": 0,
    "number_available": 0
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

Responses

200

Returns SensorRegistrationTokenInfo of type(s) application/json

This response body class contains all of the following: InlineSensorRegistrationTokenInfo1

"SensorRegistrationTokenInfo Object"

default

Error

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.

Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    platform-sensor-lic

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/sensors/registration-tokens

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Vendor Extension

Sensor Operations

POST

Create Registration Token