REST Resource: nodes.nodes.devices

  • The Device resource represents a registered device within the Spectrum Access System (SAS), containing device-specific information like FCC ID, serial number, and operational state.

  • Devices can be created and managed under a specific node or customer using provided methods.

  • The JSON representation of a device includes key fields like name, configuration details, grants, and metadata.

  • Available methods for Device resources include create, createSigned, and list, allowing for device registration and retrieval.

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

create

Creates a device under a node or customer.

createSigned

Creates a signed device under a node or customer.

list

Lists devices under a node or customer.