Skip to content

System⚓︎

Path⚓︎

/v1/sys

The System resource maps to a network subnet. Subscribers are assigned to one System. A System can be shared by multiple Sites but is owned by only one Customer.

 

Resource Attributes⚓︎

The attributes for the System resource are detailed below:

Attribute Type Required? Description
name String YES The name of the System.
status String YES The current status of the System (e.g., Active or Inactive).
roamingProfile String NO The roaming profile assigned to the System (link).
extensions Object NO A container for additional metadata or custom parameters.

Example⚓︎

{
  "name": "RobotNetwork1",
  "status": "Active",
  "roamingProfile": "{baseUrl}/v1/roaming-profiles/123",
  "extensions": {}
}

Note⚓︎

Systems are identified in API calls by a <systemID>. The <systemID> can be discovered when a specific System instance is selected in the HAL Explorer.

 

Endpoints⚓︎

Request Examples⚓︎

Get a list of Systems:⚓︎

{baseUrl}/v1/sys/

Get details about a System using the System Name:⚓︎

{baseUrl}/v1/sys/search/findByName?name=RobotNetwork1

Example Response:⚓︎

{
  "name": "RobotNetwork1",
  "status": "Active",
  "extensions": {
    "subscriberServiceEnabled": "true",
    "network": "Private Cloud"
  }
}

Get the Sites associated with a selected System:⚓︎

{baseUrl}/v1/sys/<systemID>/sites

Where <systemID> is a unique identifier for the System. A System can be shared by multiple Sites.

 

Create System⚓︎

Send a POST to {baseUrl}/v1/sys with the following parameters to create a new System: name, status, and customer.

{
    "name":"RobotNetwork1",
    "status":"Active",
    "customer":"{baseUrl}/v1/customers/<customerID>",
}