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.
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 followinghttps://app.sleuth.io/
PROJECT_SLUG
: found in the URL, following the prefixhttps://app.sleuth.io/org_slug/
Mandatory parameters
Optional parameters
Responses
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. |
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. |
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. |
Make sure you replace the values surrounded by
<
and >
with your own values. 1
Invoke-RestMethod -Method POST `
2
-Uri 'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<DEPLOYMENT_SLUG>/register_manual_deploy' `
3
-Headers @{
4
'Authorization' = 'apikey <APIKEY>'
5
'Content-Type' = 'application/json'
6
} `
7
-Body '{
8
"name": "<NAME>",
9
"description": "<description>"
10
}'
1
Invoke-RestMethod -Method POST `
2
-Uri 'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<DEPLOYMENT_SLUG>/register_deploy' `
3
-Headers @{
4
'Content-Type' = 'application/json'
5
} `
6
-Body '{
7
"api_key": "<API_KEY>",
8
"name": "<NAME>",
9
"description": "<DESCRIPTION>"
10
}'
Last modified 10mo ago