API Introduction

The Splight API is a powerful tool that allows you to interact with the Splight platform programmatically. It provides a wide range of endpoints for managing resources, retrieving data, and performing

Authentication

To authenticate with the Splight API, you need to include your access key and secret key in the request headers. Access key and secret key are unique for each user. You can find a guide on how to create them in the GetYourKeys section of the documentation.

Secret keys can be provided to the API in the Authorization header as:

Authorization: Splight <access_id> <secret_key>

---

API Endpoints

The full set of endpoints available in the API can be found in the API Swagger.

You can find some examples of how to use the API according the resource you want to trigger in the Resources section of the documentation.

---

Filtering

The API allows you to filter resources using query parameters based on their fields, such as name, tag, and others.

The general syntax is:

{url}/?{field}__{filter}={value}" 

Where

• {url} is the endpoint URL.

• {field} is the field you want to filter by.

• {filter} is the filter type.

• {value} is the value you want to match.

Example:

{url}/?name__icontains=example

*This will retrieve all objects that contain the word "example" in their name field.

The following filter types are supported:

Filter	Description
contains	Retrives all objects that contain the specified value in the field.
icontains	Retrieves all objects that contain the specified value in the field, ignoring case.
search	Retrieves all objects that match the specified value in the field.

---

Pagination

The API response is paginated and the default page size is 20. You can use the page_size query parameters to control the pagination of the response, as the following example:

{url}/?page_size=50

In this case, the API will return 50 objects per page.