Preview Application Rollback
curl --request GET \
--url https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollbackimport requests
url = "https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback', 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.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"environment_changes": [
{ "key": "DISCORD_TOKEN", "change": "modified" },
{ "key": "NEW_FEATURE", "change": "removed" }
]
}
}
{
"response": {
"environment_changes": []
}
}
Releases
Preview Application Rollback
Previews which environment variables a rollback to this release would add, change or remove, with names and kinds of change only, never values.
GET
/
v1
/
apps
/
{id}
/
releases
/
{release_id}
/
rollback
Preview Application Rollback
curl --request GET \
--url https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollbackimport requests
url = "https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback', 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.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/apps/{id}/releases/{release_id}/rollback")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"response": {
"environment_changes": [
{ "key": "DISCORD_TOKEN", "change": "modified" },
{ "key": "NEW_FEATURE", "change": "removed" }
]
}
}
{
"response": {
"environment_changes": []
}
}
Returns which environment variables would change if you rolled the application back to this release and restored its variables. Only the variable names and the kind of change come back, never the values. Nothing is changed.
Rolling back does not restore variables unless you ask it to. Check this preview first, then send the rollback request with
Each change is compared with the current variables of the application, including the ones saved but not yet applied by a restart. Those are the variables a rollback overwrites:
restore_environment: true if the changes are the ones you want.
string
required
The ID of the application. If the application belongs to a workspace, pass its ID in the
workspace_id query parameter.string
required
The ID of the release you would roll back to, as returned by the release list.
string
If the application belongs to a workspace, the workspace’s ID.
added: the release has the variable, and the current variables do not.removed: the current variables have the variable, and the release does not. A variable created after the release and not yet applied by a restart appears asremoved.modified: both have the variable, with different values.
apps:envs scope when called with an API key. For a workspace member, it requires the apps:envs permission.
Response
object
{
"response": {
"environment_changes": [
{ "key": "DISCORD_TOKEN", "change": "modified" },
{ "key": "NEW_FEATURE", "change": "removed" }
]
}
}
{
"response": {
"environment_changes": []
}
}
Error Responses
string
Possible error codes:
UNAUTHORIZED: User is not authenticated or lacks permissions.APP_NOT_FOUND: The application does not exist, or it is not owned by this account or workspace (404).RELEASE_NOT_FOUND: The release does not exist, or it belongs to another application (404).PLAN_DOES_NOT_SUPPORT_ROLLBACK: Your plan does not include rolling back to earlier releases (403). Rollback starts on Pro.API_KEY_SCOPE_DENIED: The API key does not have theapps:envsscope (403).
string
A descriptive message providing additional details about the error.
{
"code": "RELEASE_NOT_FOUND"
}
A release keeps the variables the application was started with. Releases created before this feature launched have none saved, so their preview is always empty.