Location
Use the following APIs to retrieve the location catalog, fetch individual locations by ID, and create, delete, or update a location. For more details, see Location.
Get Catalog of Location
Endpoint
https://api-gateway.skyhigh.cloud/location
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 Header | 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/location?page[limit]=%3Cinteger%3E&page[offset]=%3Cinteger%3E" }, "data": { "entries": [ "custom_location_1747152781", "custom_location_1747069390", "custom_location_1746159918", "custom_location_1745813014085", "custom_location_1747069338" ], "name": "Locations Collection", "id": "locations" } }
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 Location by ID
Endpoint
https://api-gateway.skyhigh.cloud/location/:id
Path Variables
Key | Value | Description |
---|---|---|
id | list_employeeNames | Unique identifier of the list. |
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 | <String> | Mandatory field |
Accept | application/vnd.api+json | Mandatory field |
Sample Response
{ "data": { "id": "custom_location_1747152781", "attributes": { "logStorageRegion": "default", "samlAuthenticationId": "", "greTunnelMappingDetails": { "externalIps": [], "excludedIpRanges": [], "provisionedTunnels": [] }, "ipSecMappingDetails": { "tunnelMode": true, "defineSubnets": false, "subnets": [], "sharedSecret": "testapi", "clientAddress": "10.213.81.70", "clientId": "", "clientIdType": "clientAddress" }, "ipRangeMappingEntries": [], "name": "Bombay" } }, "links": { "self": "http://api.skyhigh.cloud/location/custom_location_1747152781" } }
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 Location
Endpoint
https://api-gateway.skyhigh.cloud/location/:id
Path Variables
Key | Value | Description |
---|---|---|
id | list_employeeNames | Unique identifier of the list. |
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": { "id": "custom_location_1747069338", "attributes": { "logStorageRegion": "default", "samlAuthenticationId": "", "greTunnelMappingDetails": { "externalIps": [], "excludedIpRanges": [], "provisionedTunnels": [] }, "ipSecMappingDetails": { "tunnelMode": true, "defineSubnets": false, "subnets": [], "sharedSecret": "testapi", "clientAddress": "10.213.81.71", "clientId": "", "clientIdType": "clientAddress" }, "ipRangeMappingEntries": [], "name": "Bombay" } } }
Sample Response
{ "data": { "id": "custom_location_1747069338", "attributes": { "name": "Bombay", "ipRangeMappingEntries": [], "ipSecMappingDetails": { "clientIdType": "clientAddress", "clientId": "", "clientAddress": "10.213.81.71", "sharedSecret": "testapi", "subnets": [], "defineSubnets": false, "tunnelMode": true }, "greTunnelMappingDetails": { "provisionedTunnels": [], "excludedIpRanges": [], "externalIps": [] }, "samlAuthenticationId": "", "logStorageRegion": "default" } }, "links": { "self": "http://api.skyhigh.cloud/location/custom_location_1747069338" } }
Error Responses
Status Code | Description |
---|---|
200 | Request successful. The server has responded as required. |
400 | The server could not understand the request. |
404 | Requested resource could not be found. |
500 | Internal server error. |
Create Location
Endpoint
https://api-gateway.skyhigh.cloud/location
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": { "attributes": { "name": "Bombay", "ipRangeMappingEntries": [], "ipSecMappingDetails": { "clientIdType": "clientAddress", "clientId": "", "clientAddress": "10.213.81.70", "sharedSecret": "testapi", "subnets": [], "defineSubnets": false, "tunnelMode": true }, "samlAuthenticationId": "", "logStorageRegion": "default", "greTunnelMappingDetails": { "provisionedTunnels": [], "excludedIpRanges": [], "externalIps": [] } } } }
Sample Response
{ "data": { "id": "custom_location_1747152781", "attributes": { "logStorageRegion": "default", "samlAuthenticationId": "", "greTunnelMappingDetails": { "externalIps": [], "excludedIpRanges": [], "provisionedTunnels": [] }, "ipSecMappingDetails": { "tunnelMode": true, "defineSubnets": false, "subnets": [], "sharedSecret": "testapi", "clientAddress": "10.213.81.70", "clientId": "", "clientIdType": "clientAddress" }, "ipRangeMappingEntries": [], "name": "Bombay" } }, "links": { "self": "http://api.skyhigh.cloud/location" } }
Error Responses
Status Code | Description |
---|---|
200 | Request successful. The server has responded as required. |
400 | The server could not understand the request. |
404 | Requested resource could not be found. |
500 | Internal server error. |
Delete Location
Endpoint
https://api-gateway.skyhigh.cloud/location/:id
Path Variables
Key | Value | Description |
---|---|---|
id | custom_location_1745813014085 | Unique identifier of the list. |
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 Response
{ "links": { "self": "http://api.skyhigh.cloud/location/custom_location_1745813014085" } }
Error Responses
Status Code | Description |
---|---|
200 | Request successful. The server has responded as required. |
400 | The server could not understand the request. |
404 | Requested resource could not be found. |
500 | Internal server error. |