Prerequisites

Create your Python program

Create a Python program called example.py, which fetches a list of endpoints from a subdomain.

1. In your working directory, create a new file called example.py, and then copy the following code into it.
   

   import requests
   
   # Build a GET request.
   url = 'https://<subdomain>.my.redcanary.co/openapi/v3/endpoints'
   headers = {'X-Api-Key': '<API key>'}
   
   # Send the request and save the response.
   response = requests.get(url, headers=headers)
   
   # Print the response body.
   print(response.content)

2. In example.py,  replace <subdomain> with the Red Canary subdomain you want to query.
3. In example.py,  replace <API key> with your API key.
4. Save example.py.

Run the example

Open the command line, and run your example.

python3 example.py

The program should print a JSON object containing the first page of endpoints associated with the subdomain.

Customize your request with parameters

You can use HTTP parameters to customize the results of your request. Visit the Red Canary API docs for a list of supported parameters for each API endpoint.

Example: Limit the number of endpoints returned

Limit the number of endpoints returned by example.py using the per_page parameter.

1. Open example.py, and then edit the GET request to match the following:
   

   # Build a GET request.
   url = 'https://<subdomain>.my.redcanary.co/openapi/v3/endpoints'
   headers = {'X-Api-Key': '<API key>'}
   params = {'per_page': '1'}
   
   # Send the request and save the response.
   response = requests.get(url, headers=headers, params=params)

   This sets the number of requested endpoints to one.
2. Save example.py, and then run the example. The program should print a JSON object containing exactly one endpoint.