Get Steering Configuration Information

Get Steering Configuration Information

Use this endpoint to get these details about your steering configuration(s):

  • Steering Configuration information
  • Exceptions for the Steering Configuration
  • On-Premises and Off-Premises Steering Configuration and Exceptions information if the configuration has Location-Based Steering enabled.

Request Endpoint

https://<tenant-URL>/api/v1/steeringconfig

Valid query parameters are:

KeyValueDescription
tokenstringRequired. The token obtained from the REST API page in the Netskope UI ( Settings > Tools > Rest API v1) is required. We recommend that you place the token in the body of the request, not in the endpoint URL.
configURL-encoded stringFilters results by the Steering Configuration name. Use a config (name) value from the steeringconfiglist API.
config_idPositive Integer (specific to a steering configuration)Filters results by the Steering Configuration ID. Use a config_id value from the steeringconfiglist API.
limitPositive integer less than 10000REST API responses can return up to 10000 records in a single response. You can use pagination to retrieve more results.
skipPositive integerSkip over some of the records (useful for pagination in combination with limit).

Note

Not using config or config_id will return all steering configurations information.

Request Example with Response using Location Based Steering

Note that the config name passed in the parameters is URL-encoded.

POST 'https://<tenant-URL>/api/v1/steeringconfig?config=location%20based%20steering
{    
    "token": "f32a973eddd7bc1602fc0f48dc0a"
} 
{
  "status": "success",
  "msg": "",
  "data": [
    {
      "steering_config": "location based steering",
      "enabled": true,
      "location_based_steering": true,
      "private_apps_enabled": false,
      "priority": "2",
      "on_prem": {
        "steered_traffic": {
          "data": [
            {
              "app_id": "101",
              "app_name": "Adrenalin",
              "disabled": "0",
              "app_domains": "adrenalin.com",
              "app_category": "HR",
              "modify_time": "2019-08-19 17:38:15",
              "app_cci": "31",
              "app_ccl": "poor"
            },
            {
              "app_id": "105",
              "app_name": "ProcessManagement",
              "disabled": "0",
              "app_domains": "processmanagement.com",
              "app_category": "Business Process Management",
              "modify_time": "2019-08-19 17:38:15",
              "app_cci": "63",
              "app_ccl": "medium"
            }
          ],
          "count": 2
        },
        "exceptions": {
          "applictions": {
            "data": [

            ],
            "count": 0
          },
          "domains": {
            "data": [

            ],
            "count": 0
          },
          "src_netloc": {
            "data": [

            ],
            "count": 0
          },
          "dst_netloc": {
            "data": [
              {
                "notes": "on-prem: [default destination location]",
                "dst_netloc": [
                  "Local IP address range"
                ]
              }
            ],
            "count": 1
          },
          "countries": {
            "data": [

            ],
            "count": 0
          },
          "cert_pinned_apps": {
            "data": [
              {
                "notes": "on-prem: [default ssl pinned app]",
                "app_name": "Amazon CloudDrive",
                "enabled": true,
                "data": {
                  "custom": false,
                  "appName": "Amazon CloudDrive",
                  "android": {
                    "action": "1",
                    "processes": [
                      "com.amazon.clouddrive",
                      "com.amazon.clouddrive"
                    ],
                    "enabled": true,
                    "domains": [
                      "drive.amazonaws.com",
      "us-east-1.amazonaws.com",
      "us-west-2.amazonaws.com",
      "drive.amazon.com",
      "amazon.ca",
      "amazon.in",
                      "amazon.co.uk"
                    ]
                  },
                  "mac": {
                    "action": "1",
                    "processes": [
                      "Amazon Cloud Dr",
                      "Amazon Cloud Drive Sync Service",
                      "Amazon Cloud Drive"
                    ],
                    "enabled": true,
                    "managed_device": false,
                    "tunnel": false,
                    "tunnel_domains": [

                    ]
                  },
                  "windows": {
                    "action": "1",
                    "processes": [
                      "AmazonCloudDriveW.exe",
                      "AmazonCloudDrive.exe"
                    ],
                    "enabled": true,
                    "managed_device": false,
                    "tunnel": false,
                    "tunnel_domains": [

                    ]
                  },
                  "ios": {
                    "action": "1",
                    "processes": [

                    ],
                    "enabled": false,
                    "domains": [
                      "drive.amazonaws.com",
      "us-east-1.amazonaws.com",
      "us-west-2.amazonaws.com",
      "drive.amazon.com",
      "amazon.ca",
      "amazon.in",
                      "amazon.co.uk"
                    ]
                  }
                }
              }
            ],
            "count": 1
          }
        }
      },
      "off_prem": {
        "steered_traffic": {
          "data": [

          ],
          "count": 0
        },
        "exceptions": {
          "categories": {
            "data": [
              {
                "categories": [
                  "Finance/Accounting",
                  "Internet Telephony",
                  "Streaming & Downloadable Audio",
                  "Streaming & Downloadable Video",
                  "Telecom and Call Center",
                  "Web Conferencing"
                ],
                "notes": "off-prem: [default categories]"
              }
            ],
            "count": 1
          },
          "domains": {
            "data": [
              {
                "domains": [
                  "android.clients.google.com",
                  "apple.com",
                  "gs.apple.com",
                  "itunes.apple.com",
                  "play.google.com",
                  "webex.com",
                  "youtube.com"
                ],
                "notes": "off-prem: [default domains]"
              }
            ],
            "count": 1
          },
          "src_netloc": {
            "data": [

            ],
            "count": 0
          },
          "dst_netloc": {
            "data": [
              {
                "notes": "off-prem: [default destination location]",
                "dst_netloc": [
                  "Local IP address range"
                ]
              }
            ],
            "count": 1
          },
          "countries": {
            "data": [

            ],
            "count": 0
          },
          "cert_pinned_apps": {
            "data": [
              {
                "notes": "off-prem: [default ssl pinned app]",
                "app_name": "Amazon CloudDrive",
                "enabled": true,
                "data": {
                  "custom": false,
                  "appName": "Amazon CloudDrive",
                  "android": {
                    "action": "1",
                    "processes": [
                      "com.amazon.clouddrive",
                      "com.amazon.clouddrive"
                    ],
                    "enabled": true,
                    "domains": [
                      "drive.amazonaws.com",
      "us-east-1.amazonaws.com",
      "us-west-2.amazonaws.com",
      "drive.amazon.com",
      "amazon.ca",
      "amazon.in",
                      "amazon.co.uk"
                    ]
                  },
                  "mac": {
                    "action": "1",
                    "processes": [
                      "Amazon Cloud Dr",
                      "Amazon Cloud Drive Sync Service",
                      "Amazon Cloud Drive"
                    ],
                    "enabled": true,
                    "managed_device": false,
                    "tunnel": false,
                    "tunnel_domains": [

                    ]
                  },
                  "windows": {
                    "action": "1",
                    "processes": [
                      "AmazonCloudDriveW.exe",
                      "AmazonCloudDrive.exe"
                    ],
                    "enabled": true,
                    "managed_device": false,
                    "tunnel": false,
                    "tunnel_domains": [

                    ]
                  },
                  "ios": {
                    "action": "1",
                    "processes": [

                    ],
                    "enabled": false,
                    "domains": [
                      "drive.amazonaws.com",
                      "us-east-1.amazonaws.com",
                      "us-west-2.amazonaws.com",
                      "drive.amazon.com",
                      "amazon.ca",
                      "amazon.in",
                      "amazon.co.uk"
                    ]
                  }
                }
              }
            ],
            "count": 1
          }
        }
      }
    }
  ]
}

Request Example with Response using Config ID

POST 'https://<tenant-URL>/api/v1/steeringconfig?config_id=2
{    
    "token": "f32a973eddd7bc1602fc0f48dc0a"
} 
{
  status: "success",
  msg: "",
  data: [
    {
      steering_config: "web",
      enabled: true,
      location_based_steering: false,
      private_apps_enabled: false,
      priority: "1",
      traffic_type: "web",
      steered_traffic: {
        data: [

        ],
        count: 0
      },
      exceptions: {
        categories: {
          data: [
            {
              categories: [
                "Adult Content - Other",
                "Advocacy Groups & Trade Associations"
              ],
              notes: "bypass categories"
            }
          ],
          count: 1
        },
        domains: {
          data: [
            {
              domains: [

              ],
              notes: null
            },
            {
              domains: [
                "www.facebook.com",
                "www.google.com"
              ],
              notes: "bypass google and facebook"
            }
          ],
          count: 2
        },
        src_netloc: {
          data: [
            {
              notes: "bypass source locations",
              src_netloc: [
                "Any network 2",
                "Lab Subnet"
              ]
            }
          ],
          count: 1
        },
        dst_netloc: {
          data: [
            {
              notes: "default destination location",
              dst_netloc: [
                "Local IP address range"
              ]
            },
            {
              notes: "bypass destination locations",
              dst_netloc: [
                "162.16.192.65-range OUTside",
                "nw_location"
              ]
            }
          ],
          count: 2
        },
        countries: {
          data: [
            {
              notes: "bypass traffic from these countries",
              countries: [
                "Andorra",
                "American Samoa"
              ]
            }
          ],
          count: 1
        },
        cert_pinned_apps: {
          data: [
            {
              notes: "default ssl pinned app",
              app_name: "Amazon CloudDrive",
              enabled: true,
              data: {
                custom: false,
                appName: "Amazon CloudDrive",
                android: {
                  action: "1",
                  processes: [
                    "com.amazon.clouddrive",
                    "com.amazon.clouddrive"
                  ],
                  enabled: true,
                  domains: [
                    "drive.amazonaws.com",
    "us-east-1.amazonaws.com",
    "us-west-2.amazonaws.com",
    "drive.amazon.com",
    "amazon.ca",
    "amazon.in",
                    "amazon.co.uk"
                  ]
                },
                mac: {
                  action: "1",
                  processes: [
                    "Amazon Cloud Dr",
                    "Amazon Cloud Drive Sync Service",
                    "Amazon Cloud Drive"
                  ],
                  enabled: true,
                  managed_device: false,
                  tunnel: false,
                  tunnel_domains: [

                  ]
                },
                windows: {
                  action: "1",
                  processes: [
                    "AmazonCloudDriveW.exe",
                    "AmazonCloudDrive.exe"
                  ],
                  enabled: true,
                  managed_device: false,
                  tunnel: false,
                  tunnel_domains: [

                  ]
                },
                ios: {
                  action: "1",
                  processes: [

                  ],
                  enabled: false,
                  domains: [
                    "drive.amazonaws.com",
    "us-east-1.amazonaws.com",
    "us-west-2.amazonaws.com",
    "drive.amazon.com",
    "amazon.ca",
    "amazon.in",
                    "amazon.co.uk"
                  ]
                }
              }
            },
            {
              notes: "default ssl pinned app",
              app_name: "Ablaze",
              enabled: true,
              data: {
                custom: false,
                appName: "Adrenalin",
                windows: {
                  action: "1",
                  processes: [
                    "Adrnln.exe"
                  ],
                  enabled: true,
                  managed_device: false,
                  tunnel: false,
                  tunnel_domains: [

                  ]
                },
                mac: {
                  action: "1",
                  managed_device: false,
                  tunnel: false,
                  tunnel_domains: [

                  ],
                  processes: [

                  ],
                  enabled: false,
                  domains: [
                    "adrenalin.com"
                  ]
                },
                android: {
                  action: "1",
                  processes: [

                  ],
                  enabled: false,
                  domains: [
                    "adrenalin.com"
                  ]
                },
                ios: {
                  action: "1",
                  processes: [

                  ],
                  enabled: false,
                  domains: [
                    "adrenalin.com"
                  ]
                }
              }
            }
          ],
          count: 2
        }
      }
    }
  ]
}
Share this Doc

Get Steering Configuration Information

Or copy link

In this topic ...