Skip to main content
GET
/
org
/
{name}
Get an org by name
curl --request GET \
  --url https://api.cpln.io/org/{name} \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.cpln.io/org/{name}"

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/{name}', 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/{name}",
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/{name}"

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/{name}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "id": "<string>",
  "kind": "<string>",
  "version": 123,
  "description": "<string>",
  "tags": {},
  "created": "2023-11-07T05:31:56Z",
  "lastModified": "2023-11-07T05:31:56Z",
  "links": [
    {
      "rel": "<string>",
      "href": "<string>"
    }
  ],
  "name": "<string>",
  "spec": {
    "logging": {
      "s3": {
        "bucket": "<string>",
        "region": "<string>",
        "prefix": "/",
        "credentials": "<string>"
      },
      "coralogix": {
        "credentials": "<string>",
        "app": "<string>",
        "subsystem": "<string>"
      },
      "datadog": {
        "credentials": "<string>"
      },
      "logzio": {
        "credentials": "<string>"
      },
      "elastic": {
        "aws": {
          "host": "<string>",
          "port": 123,
          "index": "<string>",
          "type": "<string>",
          "credentials": "<string>",
          "region": "<string>"
        },
        "elasticCloud": {
          "index": "<string>",
          "type": "<string>",
          "credentials": "<string>",
          "cloudId": "<string>"
        },
        "generic": {
          "host": "<string>",
          "port": 123,
          "path": "<string>",
          "index": "<string>",
          "type": "<string>",
          "credentials": "<string>",
          "username": "<string>",
          "password": "<string>"
        }
      },
      "cloudWatch": {
        "credentials": "<string>",
        "retentionDays": 123,
        "groupName": "<string>",
        "streamName": "<string>",
        "extractFields": {}
      },
      "fluentd": {
        "host": "<string>",
        "port": 123
      },
      "stackdriver": {
        "credentials": "<string>"
      },
      "syslog": {
        "host": "<string>",
        "port": 123,
        "mode": "tcp",
        "format": "rfc5424",
        "severity": 123
      },
      "opentelemetry": {
        "endpoint": "<string>",
        "headers": {},
        "credentials": "<string>"
      },
      "loki": {
        "endpoint": "<string>",
        "credentials": "<string>",
        "tenantId": "<string>"
      }
    },
    "extraLogging": [
      {
        "s3": {
          "bucket": "<string>",
          "region": "<string>",
          "prefix": "/",
          "credentials": "<string>"
        },
        "coralogix": {
          "credentials": "<string>",
          "app": "<string>",
          "subsystem": "<string>"
        },
        "datadog": {
          "credentials": "<string>"
        },
        "logzio": {
          "credentials": "<string>"
        },
        "elastic": {
          "aws": {
            "host": "<string>",
            "port": 123,
            "index": "<string>",
            "type": "<string>",
            "credentials": "<string>",
            "region": "<string>"
          },
          "elasticCloud": {
            "index": "<string>",
            "type": "<string>",
            "credentials": "<string>",
            "cloudId": "<string>"
          },
          "generic": {
            "host": "<string>",
            "port": 123,
            "path": "<string>",
            "index": "<string>",
            "type": "<string>",
            "credentials": "<string>",
            "username": "<string>",
            "password": "<string>"
          }
        },
        "cloudWatch": {
          "credentials": "<string>",
          "retentionDays": 123,
          "groupName": "<string>",
          "streamName": "<string>",
          "extractFields": {}
        },
        "fluentd": {
          "host": "<string>",
          "port": 123
        },
        "stackdriver": {
          "credentials": "<string>"
        },
        "syslog": {
          "host": "<string>",
          "port": 123,
          "mode": "tcp",
          "format": "rfc5424",
          "severity": 123
        },
        "opentelemetry": {
          "endpoint": "<string>",
          "headers": {},
          "credentials": "<string>"
        },
        "loki": {
          "endpoint": "<string>",
          "credentials": "<string>",
          "tenantId": "<string>"
        }
      }
    ],
    "tracing": {
      "sampling": 123,
      "lightstep": {
        "endpoint": "<string>",
        "credentials": "<string>"
      },
      "customTags": {},
      "provider": {
        "otel": {
          "endpoint": "<string>"
        },
        "lightstep": {
          "endpoint": "<string>",
          "credentials": "<string>"
        },
        "controlplane": {}
      }
    },
    "sessionTimeoutSeconds": 123,
    "authConfig": {
      "domainAutoMembers": [
        "<string>"
      ],
      "samlOnly": true
    },
    "observability": {
      "logsRetentionDays": 123,
      "metricsRetentionDays": 123,
      "tracesRetentionDays": 123,
      "defaultAlertEmails": [
        "<string>"
      ]
    },
    "security": {
      "threatDetection": {
        "enabled": true,
        "syslog": {
          "transport": "tcp",
          "host": "<string>",
          "port": 123
        }
      }
    }
  },
  "status": {
    "accountLink": "<string>",
    "active": true,
    "endpointPrefix": "<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

name
string
required

Response

Success

id
string
read-only
kind
string
read-only
version
integer
read-only
description
string
Maximum string length: 250
tags
object
created
string<date-time>
read-only
lastModified
string<date-time>
read-only
name
string
Maximum string length: 64
spec
object
status
object
read-only