Update deployment
curl --request PUT \
--url https://api.example.com/api/deployments/{deploymentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"updateSecrets": false,
"secrets": "<unknown>"
}
'import requests
url = "https://api.example.com/api/deployments/{deploymentId}"
payload = {
"name": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"updateSecrets": False,
"secrets": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
configuration: '<unknown>',
updateSecrets: false,
secrets: '<unknown>'
})
};
fetch('https://api.example.com/api/deployments/{deploymentId}', 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.example.com/api/deployments/{deploymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'configuration' => '<unknown>',
'updateSecrets' => false,
'secrets' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.example.com/api/deployments/{deploymentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"configuration\": \"<unknown>\",\n \"updateSecrets\": false,\n \"secrets\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/api/deployments/{deploymentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"configuration\": \"<unknown>\",\n \"updateSecrets\": false,\n \"secrets\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/deployments/{deploymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"configuration\": \"<unknown>\",\n \"updateSecrets\": false,\n \"secrets\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"displayName": "<string>",
"onboarded": true,
"themeLogo": "<string>",
"themePrimaryColor": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"license": "<string>",
"licenseData": "<unknown>",
"url": "<string>",
"preferences": "<unknown>",
"deletedAt": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"deletedAt": "<string>"
}Deployments
Update deployment
Update an existing deployment configuration by its ID.
PUT
/
api
/
deployments
/
{deploymentId}
Update deployment
curl --request PUT \
--url https://api.example.com/api/deployments/{deploymentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"updateSecrets": false,
"secrets": "<unknown>"
}
'import requests
url = "https://api.example.com/api/deployments/{deploymentId}"
payload = {
"name": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"updateSecrets": False,
"secrets": "<unknown>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
configuration: '<unknown>',
updateSecrets: false,
secrets: '<unknown>'
})
};
fetch('https://api.example.com/api/deployments/{deploymentId}', 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.example.com/api/deployments/{deploymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'configuration' => '<unknown>',
'updateSecrets' => false,
'secrets' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.example.com/api/deployments/{deploymentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"configuration\": \"<unknown>\",\n \"updateSecrets\": false,\n \"secrets\": \"<unknown>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/api/deployments/{deploymentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"configuration\": \"<unknown>\",\n \"updateSecrets\": false,\n \"secrets\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/deployments/{deploymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"configuration\": \"<unknown>\",\n \"updateSecrets\": false,\n \"secrets\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"displayName": "<string>",
"onboarded": true,
"themeLogo": "<string>",
"themePrimaryColor": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"license": "<string>",
"licenseData": "<unknown>",
"url": "<string>",
"preferences": "<unknown>",
"deletedAt": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"configuration": "<unknown>",
"deletedAt": "<string>"
}Path Parameters
Unique identifier of the deployment to update
Body
application/json
Response
200 - application/json
The updated deployment
The updated deployment
Unique identifier of the deployment
Name of the deployment
Cloud storage provider type (aws_s3, azure_storage, google_cloud_storage)
Available options:
aws_s3, azure_storage, google_cloud_storage ID of the organisation this deployment belongs to
Organisation associated with the deployment
Show child attributes
Show child attributes
Timestamp when the deployment was created
Timestamp when the deployment was last updated
Description of the deployment
Provider-specific configuration settings
Timestamp when the deployment was deleted
Was this page helpful?
⌘I