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
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 followinghttps://app.sleuth.io/
DEPLOYMENT_SLUG
: found in the URL, following the prefixhttps://app.sleuth.io/org_slug/deployments/
Parameters
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.
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
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
.
When using the Organization API token found under Organization Settings > Details, the Authorization
header needs to pass the API key via apikey
e.g. Authorization: apikey <APIKEY>
When using API tokens created under Organization Settings > Access Tokens the Authorization
header needs to pass the API token via Bearer
e.g. Authorization: Bearer <API_TOKEN>
Last updated
Was this helpful?