SCP
Use the following APIs to retrieve the SCP policy catalog, fetch individual SCP policies by ID, and export the SCP policy.
Get Catalog of SCP Policy
API: GET https://api-gateway.skyhigh.cloud/scp
Query Parameters
| Parameter | Type | Sample |
|---|---|---|
| page[limit] | <Integer> | 1 |
| page[offset] | <Integer> | 4 |
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 |
| Content-Type | application/vnd.api+json | Mandatory field |
Sample Response
{
"links": {
"self": "http://api.skyhigh.cloud/scp?page[limit]=%3Cinteger%3E&page[offset]=%3Cinteger%3E"
},
"data": [
{
"id": "f50c7e79-5a7f-4952-aa15-bf93cc4be23c",
"name": "Policy 1"
}
]
}
The response returns a binary .zip or .bin file containing the complete policy backup.
Response Type: application/octet-stream
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 SCP Policy by ID
API: GET https://api-gateway.skyhigh.cloud/scp/:id
Path Variables
| Key | Value | Description |
|---|---|---|
| id | f50c7e79-5a7f-4952-aa15-bf93cc4be23c | 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 |
| Content-Type | application/vnd.api+json | Mandatory field |
Response
{
"data": {
"adminConfig": {
"blockIfPrimaryServerUnreachable": false,
"additionalRedirectPorts": [
{
"port": 80,
"sendToAltProxy": false
},
{
"port": 443,
"sendToAltProxy": false
}
],
"blockIPv6": true,
"blockConnectionIfCertVerificationFails": false,
"nonRedirectPorts": "ALLOWDIRECT",
"redirectUserSpaceAppTraffic": false,
"blockUDP": true,
"enableAccessProtection": false,
"redirectOSCoreTraffic": false,
"validateUsingCertificateList": true,
"blockIfMutualAuthFails": false,
"bypassLocalAddr": false,
"enableSecureChannel": true,
"selectPortForSecureChannel": "PORT_8081",
"honorGatewaySelectionMethod": false,
"blockProcessList": [
{
"process": "chrome.exe",
"comment": ""
},
{
"process": "Google Chrome",
"comment": ""
},
{
"process": "Google Chrome Helper",
"comment": ""
},
{
"process": "firefox.exe",
"comment": ""
},
{
"process": "firefox",
"comment": ""
},
{
"process": "iexplore.exe",
"comment": ""
},
{
"process": "opera.exe",
"comment": ""
},
{
"process": "Opera",
"comment": ""
},
{
"process": "Opera Helper",
"comment": ""
},
{
"process": "safari.exe",
"comment": ""
},
{
"process": "safari",
"comment": ""
},
{
"process": "com.apple.Webkit",
"comment": ""
}
],
"blockIfClientBusy": false,
"enableUninstallProtection": false,
"proxyUpdateCheckFreqInMins": 5,
"cannotConnectToSecureChannel": "ALLOW_CONNECTION_WITHOUT_SECURE_CHANNEL",
"allowUDPforPA": false,
"redirectMPATraffic": false
},
"description": "",
"alternateProxyServer": "254d4b88-a830-45fd-8b2b-a8eb5c80b049",
"redirectionListConfig": {
"redirectTenantRestrictionApps": false,
"ipAddrList": [],
"processList": [],
"lists": [],
"splitRedirInExplicitProxy": false,
"redirectActivityControlApps": false,
"domainList": []
},
"activeDirectoryConfig": {
"filters": [],
"adGroupHeaderSize": 8
},
"updatedTimestamp": "",
"version": 32,
"name": "Policy 1",
"bypassListConfig": {
"domainList": [],
"ipAddrList": [],
"processList": [],
"bypassOnPremTraffic": false,
"portList": [],
"localAddrList": [],
"vpnAddrList": []
},
"id": "f50c7e79-5a7f-4952-aa15-bf93cc4be23c",
"macOSConfig": {
"logLevel": "ERRORCRITICAL"
},
"primaryProxyServer": "9b5a22c7-f22e-4681-98cc-840c16102534",
"createdTimestamp": "",
"firewallSettingsConfig": {
"isFirewallEnabled": false,
"firewallMode": "SendAllExcept",
"trafficSelectionList": {
"domainList": [],
"ipAddrList": [],
"processList": [],
"portList": []
},
"httpProxyAuthentication": {
"enabled": false,
"address": "",
"port": ""
},
"socksProxy": {
"enabled": false,
"address": "",
"port": ""
}
}
},
"links": {
"self": "http://api.skyhigh.cloud/scp/f50c7e79-5a7f-4952-aa15-bf93cc4be23c"
}
}
The response returns a binary .zip or .bin file containing the complete policy backup.
Response Type: application/octet-stream
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. |
Export SCP Policy
API: GET https://api-gateway.skyhigh.cloud/scp/:id/opg
Query Parameters
| Parameter | Type | Sample |
|---|---|---|
| page[limit] | <Integer> | 1 |
| page[offset] | <Integer> | 4 |
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 |
| Content-Type | application/vnd.api+json | Mandatory field |
Sample Response
The response returns.OPG file containing the complete policy backup. Response Type: application/octet-stream
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. |