Sleuth API

The Sleuth REST API provides methods that enables users to:

  • Manually register their deploys

  • Submit manual changes

Authentication

The Sleuth REST API requires authentication using the API key from your Sleuth project.

post
Manual Deploy Registration

https://app.sleuth.ioapi/1/<Organization Slug>/<Deployment Slug>/register_deploy
Manually register your deploys via the Sleuth API. Keep in mind that the organization and deployment slugs are not the semantic name of your organization and deployment as shown in the organization settings, which can contains spaces and capitalized characters. Rather, they're the slugs as displayed in the URL of your organization and deployment, with spaces and replaced by a hyphen (-); non-alphabetical characters (e.g., ()@#$%^, etc.) are 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 https://app.sleuth.io/amazing-software/deployments/plugin-picker-dev. The organization slug is amazing-software, the deployment slug is plugin-picker-dev.
Request
Response
Request
Path Parameters
Organization Slug
required
string
Slug of the organization parent of the affected code deployment
Deployment Slug
required
string
Slug of the code deployment
Form Data Parameters
email
optional
string
Email address of author
date
optional
string
ISO 8601 deployment date string
api_key
required
string
Located in the Organization Settings > Details > Api Key field
sha
required
string
Deployment code SHA that defines the deployment. Look in copy for tracking your deploys page
Response
200: OK
Success
400: Bad Request
Input date problem, including if SHA doesn't exist or has already been reported.
String of message problem
401: Unauthorized
API key not valid or the deployment is not in the specific organization
String of message problem

post
Manual Change

https://app.sleuth.io/api/1/deployments/<Organization Slug>/<Project Slug>/register_manual_deploy
Manual changes are those not tracked by source code, feature flags, or any other type of change not supported by Sleuth. They are a free-form entry that includes a name and description. Although the description is optional, the form data in the manual change must contain a name as one of its parameters. For example, if you're viewing a project called Software Selector and your organization is called Amazing Software, the URL will display as https://app.sleuth.io/amazing-software/software-selector. The organization slug is amazing-software, the project slug is software-selector.
Request
Response
Request
Path Parameters
Organization Slug
required
string
Slug of the organization parent of the affected code deployment
Project Slug
required
string
Slug of the project that you're registering a deploy to
Form Data Parameters
api_key
required
string
Located in the Organization Settings > Details > Api Key field
email
optional
string
Email address of the user associated with the project receiving the manual change
name
required
string
Title for the manual change
description
optional
string
Description for the manual change
Response
200: OK
Success.
Success.
302: Found

post
Environment Deploy Registration

https://app.sleuth.ioapi/1/deployments/sleuth/production-app/register_deploy
If there is one environment defined and the parameter isn’t provided, Sleuth will register the deploy against that one environment. For multiple defined environments in which the parameter isn’t provided, Sleuth will register the deploy against the default environment (there can only be one default environment). If the environment is provided and it matches a configured environment, Sleuth will register the deploy against that environment.
Request
Response
Request
Path Parameters
optional
string
Response
200: OK