Skip to main content
GET
/
org
/
{org}
/
gvc
/
{gvc}
/
workload
/
{workload}
/
deployment
List deployments in a workload
curl --request GET \
  --url https://api.cpln.io/org/{org}/gvc/{gvc}/workload/{workload}/deployment \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.cpln.io/org/{org}/gvc/{gvc}/workload/{workload}/deployment"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.cpln.io/org/{org}/gvc/{gvc}/workload/{workload}/deployment', 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.cpln.io/org/{org}/gvc/{gvc}/workload/{workload}/deployment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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.cpln.io/org/{org}/gvc/{gvc}/workload/{workload}/deployment"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<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.cpln.io/org/{org}/gvc/{gvc}/workload/{workload}/deployment")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cpln.io/org/{org}/gvc/{gvc}/workload/{workload}/deployment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "kind": "<string>",
  "items": [
    {}
  ],
  "links": [
    {
      "rel": "<string>",
      "href": "<string>"
    }
  ]
}
{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}
{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}

Authorizations

Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

org
string
required
gvc
string
required
workload
string
required

Response

Success

kind
string
itemKind
enum<string>
Available options:
org,
cloudaccount,
policy,
user,
group,
resource,
task,
permissions,
serviceaccount,
secret,
location,
gvc,
workload,
quota,
identity,
deployment,
event,
account,
domain,
image,
ipset,
resourcepolicy,
accessreport,
agent,
auditctx,
dbcluster,
memcachecluster,
spicedbcluster,
tenant,
mk8s,
command,
policymembership,
primitive,
foreign,
link,
imagesummary,
volumeset
items
object[]