REST Resource: customers.nodes

  • This documentation provides an overview of the Node resource within the Spectrum Access System.

  • It describes the properties of a Node, including its name, display name, and associated user IDs.

  • You can manage Nodes with various methods like creating, deleting, retrieving, listing, moving, and updating them.

  • Use the provided links within each section to access more detailed information and instructions.

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.