Integrated Systems
The following table lists the properties that can be used in the body of an integrated-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: Integrated System
| Property Name | Type | Editable | Sort/Filter | Optional in Request/Response Body? | Description |
|---|---|---|---|---|---|
| displayName | String | Yes | both | No | The display name for this integrated system. |
| description | String | Yes | both | Yes | A description of this integrated system. |
| host | String | Yes | both | No | Hostname/IP Address of the integrated system. |
| type | String<Enum> | No | both | No | The type of integrated system. |
| link | Link | No | No | No | Self- referencing link. |
Integrated System 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.
Example of Using GET for Integrated Systems
This example demonstrates how to obtain information about integrated systems with Cloudpath UI.
This example uses the following URI:
https://nsg192.cloudpath.net/admin/publicApi/integratedSystems
where https://nsg192.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).
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 | eyJhbGciOiJIUzUxMiJ9.eyJhY2NvdW50UGsiOiIxMSIsInJvbGVQayI6IjIwMDAwIiwiYXVkIjoiUkVTVF9BUEkiLCJzdWIiOiI0NyIsImlzcyI6InRrVUJYWnVIZTNtMHdPWnA1TTc0VWpycndKYk53ODRVclkxZUJJQlhtb009IiwiaWF0IjoxNjYyNjA3ODM5LCJleHAiOjE2NjI2MDgxMzl9.r-UU4CA-h2FxQ8udq6krH1kIy9JyVy9SbnsYbzHmA6yC_oMPFfQpUavlb23RkAlPLk9E8bnye7vZ3BxQAWf4wA |
None required.
Use the GET action to send the request.Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body provides information about all existing integrated systems in your Cloudpath system. In this example, the host with IP address of 10.10.10.10 is the only integrated system. The information in the response body will match the configuration of the integrated system as specified in the Cloudpath UI.
{
"page": {
"page": 1,
"pageSize": 1,
"totalCount": 1
},
"contents": [
{
"displayName": "ray@arris.com",
"description": "",
"host": "10.10.10.10",
"type": "SZ_NET_SEGMENTATION",
"links": [
{
"rel": "self",
"href": "https://nsg192.cloudpath.net/admin/publicApi/integratedSystems/239",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
}
]
}
]
}