Manual Change

Use this endpoint with the POST method to register manual changes.

Manual changes are any changes not tracked by source code, feature flags, or any other type of change not supported by Sleuth. They are free-form entries that include 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.

Path

ENDPOINT

https://app.sleuth.io/api/1/deployments/ORG_SLUG/PROJECT_SLUG/register_manual_deploy

The endpoint path takes 2 slugs which direct the manual changes to the correct code project:

• ORG_SLUG: found in the URL of your Sleuth org, immediately following https://app.sleuth.io/

• PROJECT_SLUG: found in the URL, following the prefix https://app.sleuth.io/org_slug/

Parameters

Mandatory parameters

Name	Type	Comments
api_key*	string	Can be found in the Organization Settings -> Details -> Api Key field in your Sleuth org.
name*	string	Title for the manual change.

Optional parameters

Name	Type	Comments
description	string	Description for the manual change.
environment	string	The environment to register the change against. If not provided Sleuth will use the default environment of the Project.
tags	string	A comma-delimited list of tags.
author	string	Email address of change author.
email	string	Email address of the user associated with the project receiving the manual change.

Responses

Code	Comments	Response Text
200	Manual change registered successfully.	Success
400	Returned if any of the input parameters are invalid, e.g.: - date format isn't valid - author is not a valid email	The response text will indicate the nature of the error: String of message problem
401	Returned if the API key provided doesn't exist.	Unauthorized
404	Returned if the project does not exist.	Project not found
422	Returned if name is not provided	Name is required.

Examples

Make sure you replace the values surrounded by< and >with your own values.

cURL with API key in Header

curl -X POST \
'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<DEPLOYMENT_SLUG>/register_manual_deploy' \
  -H 'Authorization: apikey <APIKEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "<NAME>",
  "description": "<description>"
}'

cURL with API key in Body

curl -X POST \
'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<DEPLOYMENT_SLUG>/register_deploy' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "<NAME>",
  "description": "<DESCRIPTION>",
  "api_key": <API_KEY>
  }'

PowerShell with API key in Header

Invoke-RestMethod -Method POST `
-Uri 'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<DEPLOYMENT_SLUG>/register_manual_deploy' `
-Headers @{
    'Authorization' = 'apikey <APIKEY>'
    'Content-Type' = 'application/json'   
} `
-Body '{
    "name": "<NAME>",
    "description": "<description>"
}'

PowerShell with API key in Body

Invoke-RestMethod -Method POST `
-Uri 'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<DEPLOYMENT_SLUG>/register_deploy' `
-Headers @{
    'Content-Type' = 'application/json'   
} `
-Body '{
    "api_key": "<API_KEY>",
    "name": "<NAME>",
    "description": "<DESCRIPTION>"
}'