Create a managed deployment
curl --request POST \
--url https://api.openworklabs.com/v1/managed-deployments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"route53ZoneId": "<string>"
},
"size": "small"
}
'import requests
url = "https://api.openworklabs.com/v1/managed-deployments"
payload = {
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"route53ZoneId": "<string>"
},
"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({
name: '<string>',
domainName: '<string>',
ownerEmail: 'jsmith@example.com',
provider: 'aws',
target: {accountId: '<string>', route53ZoneId: '<string>'},
size: 'small'
})
};
fetch('https://api.openworklabs.com/v1/managed-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.openworklabs.com/v1/managed-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 => json_encode([
'name' => '<string>',
'domainName' => '<string>',
'ownerEmail' => 'jsmith@example.com',
'provider' => 'aws',
'target' => [
'accountId' => '<string>',
'route53ZoneId' => '<string>'
],
'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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\"\n },\n \"size\": \"small\"\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")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\"\n },\n \"size\": \"small\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/managed-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["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\"\n },\n \"size\": \"small\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"provider": "aws",
"target": {
"accountId": "<string>",
"region": "us-east-1",
"route53ZoneId": "<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"
}
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Managed deployments
Create a managed deployment
Records a new installation target (cloud account, region, address). Nothing is launched until an owner prepares and approves it in their cloud.
POST
/
v1
/
managed-deployments
Create a managed deployment
curl --request POST \
--url https://api.openworklabs.com/v1/managed-deployments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"route53ZoneId": "<string>"
},
"size": "small"
}
'import requests
url = "https://api.openworklabs.com/v1/managed-deployments"
payload = {
"name": "<string>",
"domainName": "<string>",
"ownerEmail": "jsmith@example.com",
"provider": "aws",
"target": {
"accountId": "<string>",
"route53ZoneId": "<string>"
},
"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({
name: '<string>',
domainName: '<string>',
ownerEmail: 'jsmith@example.com',
provider: 'aws',
target: {accountId: '<string>', route53ZoneId: '<string>'},
size: 'small'
})
};
fetch('https://api.openworklabs.com/v1/managed-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.openworklabs.com/v1/managed-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 => json_encode([
'name' => '<string>',
'domainName' => '<string>',
'ownerEmail' => 'jsmith@example.com',
'provider' => 'aws',
'target' => [
'accountId' => '<string>',
'route53ZoneId' => '<string>'
],
'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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\"\n },\n \"size\": \"small\"\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")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\"\n },\n \"size\": \"small\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/managed-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["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"domainName\": \"<string>\",\n \"ownerEmail\": \"jsmith@example.com\",\n \"provider\": \"aws\",\n \"target\": {\n \"accountId\": \"<string>\",\n \"route53ZoneId\": \"<string>\"\n },\n \"size\": \"small\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"provider": "aws",
"target": {
"accountId": "<string>",
"region": "us-east-1",
"route53ZoneId": "<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"
}
]
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
denApiKeybearerAuth
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Body
application/json
Required string length:
1 - 80Maximum string length:
200Pattern:
^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$Maximum string length:
254Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Allowed value:
"aws"Show child attributes
Show child attributes
Allowed value:
"small"Response
Create a managed deployment
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
aws, azure, gcp Show child attributes
Show child attributes
Allowed value:
"small"Allowed value:
"approval"Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Maximum string length:
80Pattern:
^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$Maximum string length:
80Pattern:
^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?