Sleuth API
Last updated
Was this helpful?
Last updated
Was this helpful?
The Sleuth REST API provides methods that enables users to:
Register or import their deploys
Create
Register
Sleuth's main public API is built using GraphQL. It's the same API we use internally for developing our applications.
If you're new to GraphQL, Apollo has . is another good starting point.
Sleuth's GraphQL endpoint is:
We expose the client so you can explore and query the API.
The Sleuth REST API requires authentication using the API key from your Sleuth .
For Organizations with many , and configuring Sleuth via the UI can be cumbersome. The Sleuth API can be used to provision resources directly. However, many teams already rely on to provision their infrastructure and other resources.
Note that the organization and deployment slugs are not the semantic name of your organization and deployment as shown in the organization settings, which can contain spaces and capitalized characters.
Codes in the 2xx range indicate success
Codes in the 4xx range indicate incorrect or incomplete parameters
Codes in the 5xx range indicate an error with Sleuth servers
Instead of using the API directly to provision Sleuth resources, you can use Terraform and our .
The slugs displayed are the URL of your organization and deployment, with spaces replaced by a hyphen (-) and non-alphabetical characters (e.g., ()@#$%^, etc.) ignored.For example, if you're viewing a deployment called plugin picker (dev) and your organization is called Amazing Software, the URL will display as . Thus, the organization slug is amazing-software, the deployment slug is plugin-picker-dev.
