REST Resource: customers.devices

    • This document provides information on the Device resource, including its JSON representation and available methods.

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

    • You can manage devices through various methods like creating, deleting, getting, listing, moving, patching, signing, and updating.

    • The JSON representation outlines the structure of a Device object and its attributes, providing insights into its properties and relationships.

    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 .

    delete

    		Deletes a device .

    get

    		Gets details about a device .

    list

    		Lists devices under a node or customer .

    move

    		Moves a device under another node or customer .

    patch

    		Updates a device .

    signDevice

    		Signs a device .

    updateSigned

    		Updates a signed device .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: