Change an installed deployment's configuration
curl --request POST \
--url https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"expectedRevision": "<string>",
"configuration": {
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"route53ZoneId": "<string>",
"network": {
"mode": "dedicated"
},
"assistants": {
"headlessRunnerEnabled": false,
"workbotEnabled": false,
"slackAssistantEnabled": false,
"computerProvider": "off"
}
},
"size": "small"
}
}
'import requests
url = "https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes"
payload = {
"expectedRevision": "<string>",
"configuration": {
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"route53ZoneId": "<string>",
"network": { "mode": "dedicated" },
"assistants": {
"headlessRunnerEnabled": False,
"workbotEnabled": False,
"slackAssistantEnabled": False,
"computerProvider": "off"
}
},
"size": "small"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedRevision: '<string>',
configuration: {
name: '<string>',
domainName: '<string>',
ownerEmail: 'jsmith@example.com',
provider: 'aws',
target: {
accountId: '<string>',
route53ZoneId: '<string>',
network: {mode: 'dedicated'},
assistants: {
headlessRunnerEnabled: false,
workbotEnabled: false,
slackAssistantEnabled: false,
computerProvider: 'off'
}
},
size: 'small'
}
})
};
fetch('https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes', 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.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expectedRevision' => '<string>',
'configuration' => [
'name' => '<string>',
'domainName' => '<string>',
'ownerEmail' => 'jsmith@example.com',
'provider' => 'aws',
'target' => [
'accountId' => '<string>',
'route53ZoneId' => '<string>',
'network' => [
'mode' => 'dedicated'
],
'assistants' => [
'headlessRunnerEnabled' => false,
'workbotEnabled' => false,
'slackAssistantEnabled' => false,
'computerProvider' => 'off'
]
],
'size' => 'small'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes"
payload := strings.NewReader("{\n \"expectedRevision\": \"<string>\",\n \"configuration\": {\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\",\n \"network\": {\n \"mode\": \"dedicated\"\n },\n \"assistants\": {\n \"headlessRunnerEnabled\": false,\n \"workbotEnabled\": false,\n \"slackAssistantEnabled\": false,\n \"computerProvider\": \"off\"\n }\n },\n \"size\": \"small\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expectedRevision\": \"<string>\",\n \"configuration\": {\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\",\n \"network\": {\n \"mode\": \"dedicated\"\n },\n \"assistants\": {\n \"headlessRunnerEnabled\": false,\n \"workbotEnabled\": false,\n \"slackAssistantEnabled\": false,\n \"computerProvider\": \"off\"\n }\n },\n \"size\": \"small\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes")
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["Content-Type"] = 'application/json'
request.body = "{\n \"expectedRevision\": \"<string>\",\n \"configuration\": {\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\",\n \"network\": {\n \"mode\": \"dedicated\"\n },\n \"assistants\": {\n \"headlessRunnerEnabled\": false,\n \"workbotEnabled\": false,\n \"slackAssistantEnabled\": false,\n \"computerProvider\": \"off\"\n }\n },\n \"size\": \"small\"\n }\n}"
response = http.request(request)
puts response.read_body{
"outcome": "saved",
"deployment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "<string>",
"size": "small",
"updateMode": "approval",
"createdAt": "2023-11-07T05:31:56Z",
"webUrl": "<string>",
"consoleUrl": "<string>",
"installedVersion": "<string>",
"availableVersion": "<string>",
"updateAvailable": true,
"health": {
"state": "operational",
"reportedAt": "2023-11-07T05:31:56Z",
"version": "<string>",
"checks": [
{
"id": "api_health",
"status": "ok",
"value": 500000000,
"total": 500000000,
"code": "http_error"
}
]
},
"run": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "install",
"version": "<string>",
"state": "awaiting_approval",
"createdAt": "2023-11-07T05:31:56Z",
"lastSeenAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"expired": true,
"events": [
{
"sequence": 50,
"step": "runner_connected",
"outcome": "succeeded",
"receivedAt": "2023-11-07T05:31:56Z",
"errorCode": "release_verification_failed"
}
]
},
"provider": "aws",
"target": {
"accountId": "<string>",
"region": "us-east-1",
"route53ZoneId": "<string>",
"network": {
"mode": "dedicated"
},
"assistants": {
"headlessRunnerEnabled": false,
"workbotEnabled": false,
"slackAssistantEnabled": false,
"computerProvider": "off"
},
"runtimeProfile": "legacy"
},
"configuration": {
"revision": "<string>",
"lock": "aws_only",
"gatewayAvailable": true,
"change": {
"runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "awaiting_approval",
"requestedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"changes": [
{
"field": "name",
"before": "<string>",
"after": "<string>",
"effect": "saved_immediately"
}
],
"requested": {
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"region": "us-east-1",
"route53ZoneId": "<string>",
"network": {
"mode": "dedicated"
},
"assistants": {
"headlessRunnerEnabled": false,
"workbotEnabled": false,
"slackAssistantEnabled": false,
"computerProvider": "off"
},
"runtimeProfile": "legacy"
},
"size": "small"
}
}
}
}
}{
"error": "<string>",
"message": "<string>",
"field": "name"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>",
"message": "<string>",
"field": "name"
}{
"error": "<string>",
"message": "<string>",
"field": "name"
}{
"error": "<string>"
}{
"error": "<string>",
"message": "<string>",
"field": "name"
}Managed deployments
Change an installed deployment's configuration
Prepares a change to an installed AWS deployment at the installer version it already runs: the first administrator email, turning on the gateway runtime, or its cloud computers. Send the complete configuration with the revision it was read at. The answer is the command the owner runs in AWS CloudShell; the deployment’s recorded configuration changes only when that approved run has verified health. A new name is saved at once. Sending the recorded configuration while a change awaits approval withdraws it. The address, AWS account, region, hosted zone and network are fixed at installation, and the gateway runtime cannot be turned off.
POST
/
v1
/
managed-deployments
/
{deploymentId}
/
configuration-changes
Change an installed deployment's configuration
curl --request POST \
--url https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"expectedRevision": "<string>",
"configuration": {
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"route53ZoneId": "<string>",
"network": {
"mode": "dedicated"
},
"assistants": {
"headlessRunnerEnabled": false,
"workbotEnabled": false,
"slackAssistantEnabled": false,
"computerProvider": "off"
}
},
"size": "small"
}
}
'import requests
url = "https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes"
payload = {
"expectedRevision": "<string>",
"configuration": {
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"route53ZoneId": "<string>",
"network": { "mode": "dedicated" },
"assistants": {
"headlessRunnerEnabled": False,
"workbotEnabled": False,
"slackAssistantEnabled": False,
"computerProvider": "off"
}
},
"size": "small"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedRevision: '<string>',
configuration: {
name: '<string>',
domainName: '<string>',
ownerEmail: 'jsmith@example.com',
provider: 'aws',
target: {
accountId: '<string>',
route53ZoneId: '<string>',
network: {mode: 'dedicated'},
assistants: {
headlessRunnerEnabled: false,
workbotEnabled: false,
slackAssistantEnabled: false,
computerProvider: 'off'
}
},
size: 'small'
}
})
};
fetch('https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes', 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.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expectedRevision' => '<string>',
'configuration' => [
'name' => '<string>',
'domainName' => '<string>',
'ownerEmail' => 'jsmith@example.com',
'provider' => 'aws',
'target' => [
'accountId' => '<string>',
'route53ZoneId' => '<string>',
'network' => [
'mode' => 'dedicated'
],
'assistants' => [
'headlessRunnerEnabled' => false,
'workbotEnabled' => false,
'slackAssistantEnabled' => false,
'computerProvider' => 'off'
]
],
'size' => 'small'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes"
payload := strings.NewReader("{\n \"expectedRevision\": \"<string>\",\n \"configuration\": {\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\",\n \"network\": {\n \"mode\": \"dedicated\"\n },\n \"assistants\": {\n \"headlessRunnerEnabled\": false,\n \"workbotEnabled\": false,\n \"slackAssistantEnabled\": false,\n \"computerProvider\": \"off\"\n }\n },\n \"size\": \"small\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expectedRevision\": \"<string>\",\n \"configuration\": {\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\",\n \"network\": {\n \"mode\": \"dedicated\"\n },\n \"assistants\": {\n \"headlessRunnerEnabled\": false,\n \"workbotEnabled\": false,\n \"slackAssistantEnabled\": false,\n \"computerProvider\": \"off\"\n }\n },\n \"size\": \"small\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/managed-deployments/{deploymentId}/configuration-changes")
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["Content-Type"] = 'application/json'
request.body = "{\n \"expectedRevision\": \"<string>\",\n \"configuration\": {\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\",\n \"network\": {\n \"mode\": \"dedicated\"\n },\n \"assistants\": {\n \"headlessRunnerEnabled\": false,\n \"workbotEnabled\": false,\n \"slackAssistantEnabled\": false,\n \"computerProvider\": \"off\"\n }\n },\n \"size\": \"small\"\n }\n}"
response = http.request(request)
puts response.read_body{
"outcome": "saved",
"deployment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "<string>",
"size": "small",
"updateMode": "approval",
"createdAt": "2023-11-07T05:31:56Z",
"webUrl": "<string>",
"consoleUrl": "<string>",
"installedVersion": "<string>",
"availableVersion": "<string>",
"updateAvailable": true,
"health": {
"state": "operational",
"reportedAt": "2023-11-07T05:31:56Z",
"version": "<string>",
"checks": [
{
"id": "api_health",
"status": "ok",
"value": 500000000,
"total": 500000000,
"code": "http_error"
}
]
},
"run": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "install",
"version": "<string>",
"state": "awaiting_approval",
"createdAt": "2023-11-07T05:31:56Z",
"lastSeenAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"expired": true,
"events": [
{
"sequence": 50,
"step": "runner_connected",
"outcome": "succeeded",
"receivedAt": "2023-11-07T05:31:56Z",
"errorCode": "release_verification_failed"
}
]
},
"provider": "aws",
"target": {
"accountId": "<string>",
"region": "us-east-1",
"route53ZoneId": "<string>",
"network": {
"mode": "dedicated"
},
"assistants": {
"headlessRunnerEnabled": false,
"workbotEnabled": false,
"slackAssistantEnabled": false,
"computerProvider": "off"
},
"runtimeProfile": "legacy"
},
"configuration": {
"revision": "<string>",
"lock": "aws_only",
"gatewayAvailable": true,
"change": {
"runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "awaiting_approval",
"requestedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"changes": [
{
"field": "name",
"before": "<string>",
"after": "<string>",
"effect": "saved_immediately"
}
],
"requested": {
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"region": "us-east-1",
"route53ZoneId": "<string>",
"network": {
"mode": "dedicated"
},
"assistants": {
"headlessRunnerEnabled": false,
"workbotEnabled": false,
"slackAssistantEnabled": false,
"computerProvider": "off"
},
"runtimeProfile": "legacy"
},
"size": "small"
}
}
}
}
}{
"error": "<string>",
"message": "<string>",
"field": "name"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>",
"message": "<string>",
"field": "name"
}{
"error": "<string>",
"message": "<string>",
"field": "name"
}{
"error": "<string>"
}{
"error": "<string>",
"message": "<string>",
"field": "name"
}Authorizations
denApiKeybearerAuth
Path Parameters
Body
application/json
Was this page helpful?