REST API Script Examples

Our example scripts demonstrate how to programmatically extract data from the API. While they may use different variable sets, the following variables are common across all examples. Simply replace these variables in the script with your own values:

<my_public_api_key>

<my_private_api_key>

<your_domain_for_APIs>

Please input your public and private API keys where indicated and ensure they have the required level of permissions to query the selected API endpoint. Go to Management > API Keys to add, configure and view your API keys. Also make sure you have entered the correct domain for your Take Control instance, this can be found in Profile > APIs.

API Key Security: Avoid hardcoding API keys directly in your scripts for production applications. Instead, consider using environment variables or securely retrieving the keys from a server-side application.

What do you want to do now?

• Review a PowerShell device/group example.

• Appraise a cURL (batch and shell script) ticket example.