Skip to main content

Check out Interactive Visual Stories to gain hands-on experience with the SSE product features. Click here.

Skyhigh Security

List Management

Use the following APIs to retrieve the list catalog, fetch individual lists by ID, and update list.

Get Catalog of List

Endpoint

https://api-gateway.skyhigh.cloud/list-web 

Query Parameters

Parameter Type Sample
page[limit] <Integer> 1
page[offset] <Integer> 94

Authorization

Requires a valid API key with read permissions.

Key Value
Authorization X-API-KEY
Value(API Key) <String>

Headers

Key Value Description
X-API-KEY <API Key> Mandatory field
Accept application/vnd.api+json Mandatory field

Sample Response

{
    "links": {
        "last": "http://api.skyhigh.cloud/list-web?page[limit]=1&page[offset]=97",
        "next": "http://api.skyhigh.cloud/list-web?page[limit]=1&page[offset]=95",
        "prev": "http://api.skyhigh.cloud/list-web?page[limit]=1&page[offset]=93",
        "first": "http://api.skyhigh.cloud/list-web?page[limit]=1",
        "self": "http://api.skyhigh.cloud/list-web?page[limit]=1&page[offset]=94"
    },
    "data": [
        {
            "type": "VECTOR<Net.IPRange>",
            "comment": "",
            "name": "Global Blocked Destination IP Ranges New 1",
            "id": "GlobalBlockedDestinationIPRanges"
        }
    ]
}

Sample Error Responses

Status Code Description
200 Request successful. The server has responded as required.
404 The server could not understand the request. 
500 Internal server error.

Get List by ID

Endpoint

https://api-gateway.skyhigh.cloud/list-web/:id

Path Variables 

Key Value Sample Description
id <String> list_employeeNames Unique identifier of the list.

Authentication
Requires a valid API key with read permissions.

Key Value
Authorization X-API-KEY
Value(API Key) <String>

Headers

Key Value Description
X-API-KEY <String> Mandatory field
Accept application/vnd.api+json Mandatory field

Sample Response

{
    "links": {
        "self": "http://api.skyhigh.cloud/list-web/list_employeeNames"
    },
    "data": {
        "entries": [
            {
                "comment": "Docs team",
                "value": "John"
            }
        ],
        "type": "VECTOR<STRING>",
        "listFeature": "User defined",
        "comment": "",
        "name": "employeeNames",
        "variable": "list_employeeNames",
        "id": "list_employeeNames"
    }
}

Sample Error Responses

Status Code Description
200 Request successful. The server has responded as required.
404 The server could not understand the request. 
500 Internal server error.

Update List 

Endpoint

https://api-gateway.skyhigh.cloud/list-web/:id

Path Variables

Key Value Sample Description
id <String> list_employeeNames Unique identifier

Authorization
Requires a valid API key with write permissions.

Key Value
Authorization X-API-KEY
Value(API Key) <String>

Headers

Key Value Description
X-API-KEY <String> Mandatory field
Accept application/vnd.api+json Mandatory field

Sample Request Body

{
    "data": {
        "entries": [
            {
                "comment": "Docs team",
                "value": "John"
            }
        ],
        "type": "VECTOR<STRING>",
        "listFeature": "User defined",
        "comment": "",
        "name": "employeeNames",
        "variable": "list_employeeNames",
        "id": "list_employeeNames"
    }
}

Sample Response

{
    "data": {
        "id": "list_employeeNames",
        "variable": "list_employeeNames",
        "name": "employeeNames",
        "comment": "",
        "listFeature": "User defined",
        "type": "VECTOR<STRING>",
        "entries": [
            {
                "value": "HR",
                "comment": "Joey"
            }
        ]
    },
    "links": {
        "self": "http://api.skyhigh.cloud/list-web/list_employeeNames"
    }
}

Sample Error Responses

Status Code Description
200 Request successful. The server has responded as required.
400 Bad Request – Invalid input data.
404 Requested resource could not be found. 
500 Internal server error.
  • Was this article helpful?