For initiating the process to register devices to homes. This step is required unless the project was configured to allow On-Demand Device Provisioning.

Endpoints

The Registration State Response object

  • claimExpirationTimestring

    Claim Expiration Timestamp

The Registration State Response object

{
    "claimExpirationTime":"2015-04-26T09:36:25.191274242Z"
}

Update device claimable state

Endpoint
post /deviceRegistration
Description

Modify the registration state of the specified device. Only the device itself can make this request. If the claimable parameter is true, the duration parameter must also be specified.

Authorization Headers What's this?

Must contain API key of the matching device.

Body
  • deviceId

    integer

    required

    ID of device to be modified.

  • claimable

    boolean

    required

    Set device to be claimable if it is true.

  • duration

    integer

    required

    Duration of the claimable state in seconds.

Response
  • 200Successfully set the specified device to the new state.
  • 401Authorization is required to access this resource.
  • 403Request failed because of invalid data or denied permission.
  • 500An unexpected error has occurred.
  • 503The service is temporarily unavailable.

Request Body Sample

deviceId=34327&claimable=true&duration=1000

Response Body Sample

{
  "claimExpirationTime": "2019-12-18T01:11:33Z"
}