Deploy import

Use this endpoint to import deploys using a CSV file.

Delete all existing deploys in your Code Deployment and create a new history with only the deploys you specify via a CSV file. This might be useful if you wish to populate more than the default 28-days' worth of data when creating a new Code Deployment in Sleuth, or when you want to only import specific deploys, and don't want to register them individually.
Path
ENDPOINT 
https://app.sleuth.io/api/1/deployments/ORG_SLUG/DEPLOYMENT_SLUG/import_deploys
The endpoint path takes 2 slugs which direct the deploys to the correct code deployment:
ORG_SLUG: found in the URL of your Sleuth org, immediately following https://app.sleuth.io/
DEPLOYMENT_SLUG: found in the URL, following the prefix https://app.sleuth.io/org_slug/deployments/
​
Parameters
Mandatory parameters
Responses
Name
Type
Comments
api_key*
string
Can be found in the Organization Settings -> Details -> Api Key field in your Sleuth org.
csv_file*
file
The attached CSV file containing the list of deploys to import.
environment
string
The Sleuth environment slug. Defaults to the primary environment of the project.
Code
Comments
Response Text
200
Deploys imported successfully.
Success
400
Returned if any of the input parameters are invalid, e.g.:
- sha isn't provided
- branch doesn't match the configured branch
- date format isn't valid
- author is not a valid email
- we're unable to validate if the sha exists in the remote system
The response text will indicate the nature of the error:

String of message problem
401
API key not valid or the deployment is not in the specified organization
String of message problem
Importing deploys into a pre-populated code deployment will delete all existing deploys in that code deployment and create a new history with only the deploys specified in the CSV file. 
CSV File Structure
The deploys should be imported using a CSV file that is uploaded as part of the request. The CSV file should contain the headers sha and date, the sha column should contain the full SHA of the commits at the point of release, and the date column should contain the date and time of the deploy in the ISO 8601 format.
Example CSV file
1
sha,date 
2
3c02378,2002-04-03T08:34:02 
3
6f0d7cf,2002-04-01T15:03:55
Examples
Make sure you replace the values surrounded by< and >with your own values. Adjust the csv_file path accordingly or run the command from the directory that contains the csv_file.
cURL with API key in Header
1
curl \
2
'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<DEPLOYMENT_SLUG>/import_deploys' \
3
  -H 'Authorization: apikey <APIKEY>' \
4
  -F 'csv_file=@<FILENAME>.csv'
cURL with API key in Body
1
curl \
2
'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<DEPLOYMENT_SLUG>/import_deploys' \
3
  -F 'api_key=<API_KEY>' \
4
  -F 'csv_file=@<FILENAME>.csv'

Name	Type	Comments
`api_key`*	string	Can be found in the `Organization Settings` -> `Details` -> `Api Key` field in your Sleuth org.
`csv_file`*	file	The attached CSV file containing the list of deploys to import.
`environment`	string	The Sleuth environment slug. Defaults to the primary environment of the project.

Code	Comments	Response Text
`200`	Deploys imported successfully.	`Success`
`400`	Returned if any of the input parameters are invalid, e.g.: - `sha` isn't provided - branch doesn't match the configured branch - `date` format isn't valid - `author` is not a valid email - we're unable to validate if the `sha` exists in the remote system	The response text will indicate the nature of the error: `String of message problem`
`401`	API key not valid or the deployment is not in the specified organization	`String of message problem`

Deploy Registration

Manual Change

Last modified 8mo ago