Welcome to Liongard's API! You can use this API to access all of our API endpoints, such as Environments API, System Detail API, Timeline API, Agents API, and much more. The Liongard API is a RESTful API and can be used to create, retrieve, update, and delete data in your Liongard Instance.

We believe in an API product first, so most of the functionality you find in our application is available for use. We have provided a set of endpoints that our partners find most useful. You can use Liongard's API with any programming language that supports the creation of HTTPS requests and that can parse JSON.

📘
Following Forwards
In order to use the Liongard API, you must be able to automatically follow forwards (HTTP 301 Responses). All API requests return a 301 request initially as they are automatically forwarded to the API for security reasons.

URL Format

The URL needed for hitting our API follows the format below:
"https://{instance}.app.liongard.com/api/v1"

You will replace "{instance}" with your Liongard URL instance name. For example, if your instance is "https://us1.app.liongard.com," then your instance name would be "us1"

This would then be followed by the Endpoint path you wish to interact with.

The following is an example of the form of a request:
"https://us1.app.liongard.com/api/v1/environments"

Rate Limiting

The current rate limit for the Liongard API is 2000 requests within 5 minutes.

Filtering, Sorting and Pagination

You can find more information on how to use our methods for sorting and filtering with the Liongard API:

V1

Filtering and Sorting

V2

Pagination

Versioning

The current public version of the API is v1. As we add features and fix bugs, we will strive for backward compatibility to existing routes, which means we will do our best to avoid doing the following:

Renaming a field
Changing a field's data type
Making a change to validation logic

However, in some cases, these changes will be necessary, and we'll do our best to communicate these changes ahead of time if they are likely to break anything.

As we start to migrate to v2 of the API, we will slowly start deprecating v1 routes. This is going to happen slowly over time and we'll be sure to keep you updated via the Roar Report and through our documentation updates as these changes trickle in.

👍
Next
Filtering and Sorting