API Documentation
API Documentation
The Device Intelligence API allows seamless communication between computer programs, enabling automation and integration with 3rd Party Apps. This section provides an overview of the available API features and usage guidelines.
API Endpoints by Region
Use the appropriate API URL based on your region:
- US (Oregon): https://api.iotsec.goskope.com
- Germany (Frankfurt): https://api.de.iotsec.goskope.com
Understanding API URLs
An API URL consists of several components, including the API destination, version, and endpoint.
https://api.iotsec.goskope.com/v1/integrations/custom_devicecontext
- https://api.iotsec.goskope.com → API destination
- /v1 → API version (API versions may be v1 or v2, depending on the supported functionality.)
- /integrations/custom_devicecontext → API endpoint
API Authentication
Netskope Device Intelligence API uses Basic HTTP Authentication, requiring a client_id
and secret_key
.
If your credentials are incorrect, the API will return:
{
"message": "Unauthorized"
}
To obtain credentials, contact Netskope Support or the Marketing Team.
Making API Requests
You can interact with the API using:
- Command Line (cURL):
Use the curl command to send HTTP requests and receive responses:
curl –user ‘<client_id>:<secret_key>’ https://api.iotsec.goskope.com - API Platforms (e.g., Postman):
Use tools like Postman to send GET or POST requests. Enter the API URL, set the Authorization type to Basic Auth, and provide your credentials,client_id
andsecret_key
.
API Responses
All API responses are returned in JSON format.