REST Resource: nodes.nodes

  • A Node resource represents a logical grouping of devices within the Spectrum Access System.

  • Nodes are defined by their name, display name, and a list of SAS user IDs associated with their devices.

  • You can manage nodes with a set of methods: create, delete, get, list, move, and patch.

  • These methods enable comprehensive control over nodes, from initial creation to adjustments in their attributes or hierarchical positioning.

Resource: Node

The Node.

JSON representation 
{
  "name": string,
  "displayName": string,
  "sasUserIds": [
    string
  ]
}
Fields
name

string

Output only. Resource name.

displayName

string

The node's display name.

sasUserIds[]

string

User ids used by the devices belonging to this node.

Methods

create

 Creates a new node.

delete

 Deletes a node.

get

 Returns a requested node.

list

 Lists nodes.

move

 Moves a node under another node or customer.

patch

 Updates an existing node.