REST Resource: deployments.devices

  • The Device resource represents a device registered with the Spectrum Access System (SAS), including details like FCC ID, serial number, and configuration.

  • Devices can be managed through various methods like delete, get, move, patch, signDevice, and updateSigned to control their lifecycle and properties.

  • The Device resource provides information about a device's current state, grants, and operational parameters, allowing for monitoring and control within the SAS.

  • A JSON representation of the Device resource outlines its structure and the specific data fields associated with each device.

Resource: Device

JSON representation 
{
  "name": string,
  "fccId": string,
  "serialNumber": string,
  "preloadedConfig": {
    object (DeviceConfig)
  },
  "activeConfig": {
    object (DeviceConfig)
  },
  "state": enum (State),
  "grants": [
    {
      object (DeviceGrant)
    }
  ],
  "displayName": string,
  "deviceMetadata": {
    object (DeviceMetadata)
  },
  "currentChannels": [
    {
      object (ChannelWithScore)
    }
  ],
  "grantRangeAllowlists": [
    {
      object (FrequencyRange)
    }
  ]
}
Fields
name

string

Output only. The resource path name.
fccId

string

The FCC identifier of the device.
serialNumber

string

A serial number assigned to the device by the device manufacturer.
preloadedConfig

object (DeviceConfig)

Configuration of the device, as specified via SAS Portal API.
activeConfig

object (DeviceConfig)

Output only. Current configuration of the device as registered to the SAS.
state

enum (State)

Output only. Device state.
grants[]

object (DeviceGrant)

Output only. Grants held by the device.
displayName

string

Device display name.
deviceMetadata

object (DeviceMetadata)

Device parameters that can be overridden by both SAS Portal and SAS registration requests.
currentChannels[]
(deprecated)

object (ChannelWithScore)

Output only. Current channels with scores.
grantRangeAllowlists[]

object (FrequencyRange)

Only ranges that are within the allowlists are available for new grants.

Methods

delete

 Deletes a device.

get

 Gets details about a device.

move

 Moves a device under another node or customer.

patch

 Updates a device.

signDevice

 Signs a device.

updateSigned

 Updates a signed device.