Device Creation

Only Super Users can create new devices on Spoke Zone.

Request

The API endpoint for creating new devices is POST /api/v2/devices.

Be sure to provide your super user access token in the x-access-token header.

Please see the API errors page for information about any API errors you receive from this endpoint.

Fields

Required

• customerId
  • An integer that specifies the ID of the organization that the device should be assigned to.
  • In the future, this field will be deprecated in favor of an upcoming organizationId field.
• identifier
  • A human-readable string used to identify the device on Spoke Zone.
  • The identifier must be unique.

Optional

• oemId

  • An integer that specifies the ID of the OEM that the device should be assigned to.

  • This field can be temporarily null, but without an assigned OEM the device will not function correctly with most Spoke Zone features.

• modelId

  • An integer that specifies the ID of the model that the device should be assigned to.

  • This field can be temporarily null, but without an assigned model the device will not function correctly with most Spoke Zone features.

• statusId
  • An integer that specifies the device’s status.

    • 1 - Active

    • 3 - Disabled

  • If not specified, the device will default to the Disabled status.
• serialNumber
  • A string that specifies the device’s serial number.
• cpuId
  • A string that specifies the CPU ID of the device.
• uuid
  • A randomly generated UUID associated with the device.
  • This can be any string value, but it must be unique.
• manufactureDate
  • A string that specifies the device’s manufacture date in ISO 8601 format.
• userIdentifier

  • A human-readable string used to identify the device for client users on Spoke Zone.