SAS Portal API

  • The SAS Portal API provides REST resources for managing customers, deployments, devices, nodes, installers, and policies within the Spectrum Access System.

  • You can use the API to create, get, list, update, delete, and move these resources, as well as sign and update signed devices.

  • The service endpoint for the SAS Portal API is https://sasportal.googleapis.com.

  • The API offers methods for generating secrets and validating Certified Professional Installers (CPIs).

  • Access control policies can be retrieved, set, and tested using dedicated API methods for managing resource permissions.

Service: sasportal.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://sasportal.googleapis.com

REST Resource: v1alpha1.customers

Methods
get GET /v1alpha1/{name=customers/*}
Returns a requested customer.
list GET /v1alpha1/customers
Returns a list of requested customers.
patch PATCH /v1alpha1/{customer.name=customers/*}
Updates an existing customer.

REST Resource: v1alpha1.customers.deployments

Methods
create POST /v1alpha1/{parent=customers/*}/deployments
Creates a new deployment.
delete DELETE /v1alpha1/{name=customers/*/deployments/*}
Deletes a deployment.
get GET /v1alpha1/{name=customers/*/deployments/*}
Returns a requested deployment.
list GET /v1alpha1/{parent=customers/*}/deployments
Lists deployments.
move POST /v1alpha1/{name=customers/*/deployments/*}:move
Moves a deployment under another node or customer.
patch PATCH /v1alpha1/{deployment.name=customers/*/deployments/*}
Updates an existing deployment.

REST Resource: v1alpha1.customers.deployments.devices

Methods
create POST /v1alpha1/{parent=customers/*/deployments/*}/devices
Creates a device under a node or customer.
createSigned POST /v1alpha1/{parent=customers/*/deployments/*}/devices:createSigned
Creates a signed device under a node or customer.
list GET /v1alpha1/{parent=customers/*/deployments/*}/devices
Lists devices under a node or customer.

REST Resource: v1alpha1.customers.devices

Methods
create POST /v1alpha1/{parent=customers/*}/devices
Creates a device under a node or customer.
createSigned POST /v1alpha1/{parent=customers/*}/devices:createSigned
Creates a signed device under a node or customer.
delete DELETE /v1alpha1/{name=customers/*/devices/*}
Deletes a device.
get GET /v1alpha1/{name=customers/*/devices/*}
Gets details about a device.
list GET /v1alpha1/{parent=customers/*}/devices
Lists devices under a node or customer.
move POST /v1alpha1/{name=customers/*/devices/*}:move
Moves a device under another node or customer.
patch PATCH /v1alpha1/{device.name=customers/*/devices/*}
Updates a device.
signDevice POST /v1alpha1/{device.name=customers/*/devices/*}:signDevice
Signs a device.
updateSigned PATCH /v1alpha1/{name=customers/*/devices/*}:updateSigned
Updates a signed device.

REST Resource: v1alpha1.customers.nodes

Methods
create POST /v1alpha1/{parent=customers/*}/nodes
Creates a new node.
delete DELETE /v1alpha1/{name=customers/*/nodes/*}
Deletes a node.
get GET /v1alpha1/{name=customers/*/nodes/*}
Returns a requested node.
list GET /v1alpha1/{parent=customers/*}/nodes
Lists nodes.
move POST /v1alpha1/{name=customers/*/nodes/*}:move
Moves a node under another node or customer.
patch PATCH /v1alpha1/{node.name=customers/*/nodes/*}
Updates an existing node.

REST Resource: v1alpha1.customers.nodes.deployments

Methods
create POST /v1alpha1/{parent=customers/*/nodes/*}/deployments
Creates a new deployment.
list GET /v1alpha1/{parent=customers/*/nodes/*}/deployments
Lists deployments.

REST Resource: v1alpha1.customers.nodes.devices

Methods
create POST /v1alpha1/{parent=customers/*/nodes/*}/devices
Creates a device under a node or customer.
createSigned POST /v1alpha1/{parent=customers/*/nodes/*}/devices:createSigned
Creates a signed device under a node or customer.
list GET /v1alpha1/{parent=customers/*/nodes/*}/devices
Lists devices under a node or customer.

REST Resource: v1alpha1.customers.nodes.nodes

Methods
create POST /v1alpha1/{parent=customers/*/nodes/*}/nodes
Creates a new node.
list GET /v1alpha1/{parent=customers/*/nodes/*}/nodes
Lists nodes.

REST Resource: v1alpha1.deployments

Methods
get GET /v1alpha1/{name=deployments/*}
Returns a requested deployment.

REST Resource: v1alpha1.deployments.devices

Methods
delete DELETE /v1alpha1/{name=deployments/*/devices/*}
Deletes a device.
get GET /v1alpha1/{name=deployments/*/devices/*}
Gets details about a device.
move POST /v1alpha1/{name=deployments/*/devices/*}:move
Moves a device under another node or customer.
patch PATCH /v1alpha1/{device.name=deployments/*/devices/*}
Updates a device.
signDevice POST /v1alpha1/{device.name=deployments/*/devices/*}:signDevice
Signs a device.
updateSigned PATCH /v1alpha1/{name=deployments/*/devices/*}:updateSigned
Updates a signed device.

REST Resource: v1alpha1.installer

Methods
generateSecret POST /v1alpha1/installer:generateSecret
Generates a secret to be used with the ValidateInstaller.
validate POST /v1alpha1/installer:validate
Validates the identity of a Certified Professional Installer (CPI).

REST Resource: v1alpha1.nodes

Methods
get GET /v1alpha1/{name=nodes/*}
Returns a requested node.

REST Resource: v1alpha1.nodes.deployments

Methods
delete DELETE /v1alpha1/{name=nodes/*/deployments/*}
Deletes a deployment.
get GET /v1alpha1/{name=nodes/*/deployments/*}
Returns a requested deployment.
list GET /v1alpha1/{parent=nodes/*}/deployments
Lists deployments.
move POST /v1alpha1/{name=nodes/*/deployments/*}:move
Moves a deployment under another node or customer.
patch PATCH /v1alpha1/{deployment.name=nodes/*/deployments/*}
Updates an existing deployment.

REST Resource: v1alpha1.nodes.deployments.devices

Methods
create POST /v1alpha1/{parent=nodes/*/deployments/*}/devices
Creates a device under a node or customer.
createSigned POST /v1alpha1/{parent=nodes/*/deployments/*}/devices:createSigned
Creates a signed device under a node or customer.
list GET /v1alpha1/{parent=nodes/*/deployments/*}/devices
Lists devices under a node or customer.

REST Resource: v1alpha1.nodes.devices

Methods
create POST /v1alpha1/{parent=nodes/*}/devices
Creates a device under a node or customer.
createSigned POST /v1alpha1/{parent=nodes/*}/devices:createSigned
Creates a signed device under a node or customer.
delete DELETE /v1alpha1/{name=nodes/*/devices/*}
Deletes a device.
get GET /v1alpha1/{name=nodes/*/devices/*}
Gets details about a device.
list GET /v1alpha1/{parent=nodes/*}/devices
Lists devices under a node or customer.
move POST /v1alpha1/{name=nodes/*/devices/*}:move
Moves a device under another node or customer.
patch PATCH /v1alpha1/{device.name=nodes/*/devices/*}
Updates a device.
signDevice POST /v1alpha1/{device.name=nodes/*/devices/*}:signDevice
Signs a device.
updateSigned PATCH /v1alpha1/{name=nodes/*/devices/*}:updateSigned
Updates a signed device.

REST Resource: v1alpha1.nodes.nodes

Methods
create POST /v1alpha1/{parent=nodes/*}/nodes
Creates a new node.
delete DELETE /v1alpha1/{name=nodes/*/nodes/*}
Deletes a node.
get GET /v1alpha1/{name=nodes/*/nodes/*}
Returns a requested node.
list GET /v1alpha1/{parent=nodes/*}/nodes
Lists nodes.
move POST /v1alpha1/{name=nodes/*/nodes/*}:move
Moves a node under another node or customer.
patch PATCH /v1alpha1/{node.name=nodes/*/nodes/*}
Updates an existing node.

REST Resource: v1alpha1.nodes.nodes.deployments

Methods
create POST /v1alpha1/{parent=nodes/*/nodes/*}/deployments
Creates a new deployment.
list GET /v1alpha1/{parent=nodes/*/nodes/*}/deployments
Lists deployments.

REST Resource: v1alpha1.nodes.nodes.devices

Methods
create POST /v1alpha1/{parent=nodes/*/nodes/*}/devices
Creates a device under a node or customer.
createSigned POST /v1alpha1/{parent=nodes/*/nodes/*}/devices:createSigned
Creates a signed device under a node or customer.
list GET /v1alpha1/{parent=nodes/*/nodes/*}/devices
Lists devices under a node or customer.

REST Resource: v1alpha1.nodes.nodes.nodes

Methods
create POST /v1alpha1/{parent=nodes/*/nodes/*}/nodes
Creates a new node.
list GET /v1alpha1/{parent=nodes/*/nodes/*}/nodes
Lists nodes.

REST Resource: v1alpha1.policies

Methods
get POST /v1alpha1/policies:get
Gets the access control policy for a resource.
set POST /v1alpha1/policies:set
Sets the access control policy on the specified resource.
test POST /v1alpha1/policies:test
Returns permissions that a caller has on the specified resource.