Report deploys to Atatus from the Bash shell
Make an HTTP POST request to https://api.atatus.com/v2/projects/<your_projectId>/deployments
. Atatus will then save and process the deployed information.
copy
curl https://api.atatus.com/v2/projects/<your_projectId>/deployments \
-F api_key="YOUR_API_KEY_HERE" \
-F revision="Git SHA or build number" \
-F release_stage="production" \
-F user="User who deployed" \
-F changes="Deployment changes"
Parameters
Some of the following parameters are required to monitor the newly deployed version of your application.
Name | Description |
---|---|
projectId (Required) | A unique identifier for a project. See here to locate the Project ID |
api_key (Required) | See here to locate the API key |
revision (Required) | Revision being deployed, such as a Git SHA or version |
release_stage (Required) | Release stage of the deployment Example, production and staging |
user (Optional) | The name of the user who deployed |
changes (Optional) | Change log or comments to record with this deploy |
Response Codes
The following response codes will tell the status of your requests.
Code | Meaning |
---|---|
200 | OK - Uploaded successfully |
422 | Non processable entity - There was an error validating the upload |
Important:
To record deployments, you need to have an API key with the Write permission. You can create your API key from your account settings.