List the organization's managed deployments
curl --request GET \
--url https://api.openworklabs.com/v1/managed-deployments \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/managed-deployments"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/managed-deployments"
req, _ := http.NewRequest("GET", url, nil)
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.get("https://api.openworklabs.com/v1/managed-deployments")
.header("x-api-key", "<api-key>")
.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::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"deployments": [
{
"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
List the organization's managed deployments
Returns each installation in the organization’s own cloud accounts with its latest installer run, health checks and available update.
GET
/
v1
/
managed-deployments
List the organization's managed deployments
curl --request GET \
--url https://api.openworklabs.com/v1/managed-deployments \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/managed-deployments"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/managed-deployments"
req, _ := http.NewRequest("GET", url, nil)
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.get("https://api.openworklabs.com/v1/managed-deployments")
.header("x-api-key", "<api-key>")
.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::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"deployments": [
{
"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>"
}Was this page helpful?