Record a deployment
curl --request POST \
--url https://api.atatus.com/v2/projects/{projectId}/deployments \
--header 'Content-Type: multipart/form-data' \
--header 'X-API-KEY: <api-key>' \
--form revision=78ec672405a \
--form release_stage=production \
--form 'user=John Doe' \
--form 'changes=Added Queue processing.'import requests
url = "https://api.atatus.com/v2/projects/{projectId}/deployments"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--"
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('revision', '78ec672405a');
form.append('release_stage', 'production');
form.append('user', 'John Doe');
form.append('changes', 'Added Queue processing.');
const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};
options.body = form;
fetch('https://api.atatus.com/v2/projects/{projectId}/deployments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.atatus.com/v2/projects/{projectId}/deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.atatus.com/v2/projects/{projectId}/deployments"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.atatus.com/v2/projects/{projectId}/deployments")
.header("X-API-KEY", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atatus.com/v2/projects/{projectId}/deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"Message": "API key is invalid!"
}{
"Message": "Validation failed"
}{
"Message": "Too many requests"
}{
"Message": "Internal server error"
}Deployments
Record a deployment
Notifies Atatus that a new version of your application was deployed, so its performance can be compared with previous deployments. Send the source revision, Git SHA or application version in revision.
POST
/
projects
/
{projectId}
/
deployments
Record a deployment
curl --request POST \
--url https://api.atatus.com/v2/projects/{projectId}/deployments \
--header 'Content-Type: multipart/form-data' \
--header 'X-API-KEY: <api-key>' \
--form revision=78ec672405a \
--form release_stage=production \
--form 'user=John Doe' \
--form 'changes=Added Queue processing.'import requests
url = "https://api.atatus.com/v2/projects/{projectId}/deployments"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--"
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('revision', '78ec672405a');
form.append('release_stage', 'production');
form.append('user', 'John Doe');
form.append('changes', 'Added Queue processing.');
const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};
options.body = form;
fetch('https://api.atatus.com/v2/projects/{projectId}/deployments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.atatus.com/v2/projects/{projectId}/deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.atatus.com/v2/projects/{projectId}/deployments"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.atatus.com/v2/projects/{projectId}/deployments")
.header("X-API-KEY", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atatus.com/v2/projects/{projectId}/deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"revision\"\r\n\r\n78ec672405a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"release_stage\"\r\n\r\nproduction\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nJohn Doe\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"changes\"\r\n\r\nAdded Queue processing.\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"Message": "API key is invalid!"
}{
"Message": "Validation failed"
}{
"Message": "Too many requests"
}{
"Message": "Internal server error"
}Authorizations
Your Atatus API key. You can also send it as the api_key query parameter or, for POST/PUT requests, in the request body.
Path Parameters
Body
multipart/form-data
Revision being deployed, such as a Git SHA or version.
Example:
"78ec672405a"
Release stage of the deployment. Example: production, staging.
Example:
"production"
The name of the user who deployed.
Example:
"John Doe"
Change log or comments to record with this deploy.
Example:
"Added Queue processing."
Response
Uploaded successfully