System

You can use REST API calls to obtain information about the integrated SmartZone system being used in your network segmentation groups.
new for 5.11

The following table lists the properties that can be used in the body of a system-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).)

Resource: System

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
groupStatus String<ENUM> Yes none No The current combined status of the network segmentation groups. If changed to "OUT_OF_SYNC this will update all groups that are not currently Synchronizing to that state. Current status can be ACTIVE, OUT_OF_SYNC, CONNECTION_ERROR, SYNCHRONIZING. Changes of state to "OUT_OF_SYNC" can only be applied to ACTIVE or , CONNECTION_ERROR status.
groupCount int No none No The count of network segmentation groups in the system
currentSzVersion String No none No The current version of SmartZone that is currently integrated
szHighestVersion String No none No The highest version of SmartZone that can be supported with this release

links:

self,

 Link No none No Self-referencing link.

Properties URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

Property URIs and Actions

URI Action Description Return Codes
networkSegmentationGroups/system GET Returns the network segmentation group system resource.

200- OK

401 - Unauthorized

403 - Forbidden
/networkSegmentationGroups/system PUT Allows the user to request a change to the status of the network segmentation group system resource. See resource definition for permitted changes.

200- OK

401 - Unauthorized

403 - Forbidden

Example of Using GET for Access Points

This example demonstrates how to obtain status of the integrated system.

URI:

This example uses the following URI: 

https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/system

where:

  • https://nsg192.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqZWZmLnJob2RpZUBjb21tc2NvcGUuY29tIiwicm9sZVBrIjoiMjEwMDAiLCJhY2NvdW50QWRtaW5QayI6IjIiLCJhcGlLZXkiOiJaV2NjTGpQZUdZMGUiLCJpYXQiOjE1NzU1NzUxNTcsImV4cCI6MTU3NTU3NTQ1N30.2q4KTyDUevkAAz7mJyp529Be1-ip3EC8P06Xarmz5ao

Request Body:

None required.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body provides information about the network segmentation group system resource, as shown in the example below:

{
    "groupStatus": "ACTIVE",
    "groupCount": 1,
    "currentSzVersion": "6.1.1",
    "szHighestVersion": "6.1.1",
    "links": [
        {
            "rel": "self",
            "href": "https://nsg192.cloudpath.net/admin/publicApi/networkSegmentationGroups/system",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}

Parent topic: Network Segmentation Groups