REST Resource: nodes.deployments

  • A Deployment is a resource that represents a group of devices and is associated with a unique user ID.

  • It includes properties like name, display name, SAS user IDs, and FCC Registration Numbers (FRNs).

  • You can manage Deployments using methods like delete, get, list, move, and patch to create, retrieve, update, or delete them.

  • Deployments can be associated with nodes or customers for organizational purposes.

Resource: Deployment

The Deployment.

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

string

Output only. Resource name.

displayName

string

The deployment's display name.

sasUserIds[]

string

User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.

frns[]

string

Output only. The FCC Registration Numbers (FRNs) copied from its direct parent.

Methods

delete

Deletes a deployment.

get

Returns a requested deployment.

list

Lists deployments.

move

Moves a deployment under another node or customer.

patch

Updates an existing deployment.