Overview

Endpoints and OpenAPI Documentation

Blog

Product Demos

Control Plane

API Reference

Sign up

Sign in

API Guide

What is Control Plane?

Release Notes

Compliance

1. Deploy Your First Workload

2. Configure a Custom Domain

3. Getting Started with the CLI

4. Deploy an Application

5. Service-to-Service Calls

Org (Organization)

GVC (Global Virtual Cloud)

Workloads

Policy

Principal Types

Accessing Cloud Resources

Security

Browserless CLI Login

Deploy From Docker-Compose

cpln apply

cpln convert

cpln cp

cpln delete

cpln helm

Manage CLI Profiles

Configure an Agent

Centralized Metrics Management

Configure a CDN

Configure a Domain

Invite Users

Rate Limiting

Resource Protection

Service-to-Service Calls

Create an Agent

Create an Audit Context

Create a Cloud Account

Create a Group

Create a GVC

Create an Identity

Create an Org

Create a Policy

Create a Service Account

Create a Workload

CI/CD Examples

Environment Promotion

Pull an image

Push an Image

Amazon S3

CloudWatch

Coralogix

Datadog

Logz.io

Managed Kubernetes

Generic Provider

AWS Provider

Hetzner Provider

Kubernetes Dashboard

AWS Workload Identity

AWS ECR

AWS EFS

AWS ELB

Local Path Storage

Actuator Settings

Agent Settings

Workload Settings

Volume Set settings

Terraform Provider Plugin

Agents

Audit Context

Audit Trail

Authentication

Command Line Interface

Cloud Accounts

Domains

Error Messages

Groups

Identities

Images

IP Sets

Locations

Logs

Misc

Quotas

Secrets

Service Account

User

Volume Sets

General

Autoscaling

Capacity AI

Containers

Custom Metrics

Firewall

JWT Authentication

Load Balancing

Termination Sequence

Types

Volumes

Response will contain the requested agent if the caller is authorized to view it

Get an agent by name

Delete an agent by name

Perform a Patch on an agent by name

Query agent health

Response will contain all the agents the caller is authorized to view

Get all agents

Create an agent

Get all agents based on a query

Response will contain the permissions and associated bindings (principal and granted permission) for an agent if the caller is authorized to view it

Get the access report for an agent by name

Response contains the grantable permissions that are available for an agent when adding a binding in a policy.

Get available permissions for an agent

Response will contain the requested audit context if the caller is authorized to view it

Get an audit context by name

Perform a Patch on an audit context by name

Response will contain all the audit contexts the caller is authorized to view

Get all audit contexts

Create an audit context

Get all audit contexts based on a query

Response will contain the permissions and associated bindings (principal and granted permission) for an audit context if the caller is authorized to view it

Get the access report for an audit context by name

Response contains the grantable permissions that are available for an audit context when adding a binding in a policy.

Get available permissions for an audit context

Response will contain the requested cloud account if the caller is authorized to view it

Get a cloud account by name

Delete an cloud account by name

Perform a Patch on a cloud account by name

Response will contain all the cloud accounts the caller is authorized to view

Get all cloud accounts

Create a cloud account

Get all cloud accounts based on a query

Response will contain the permissions and associated bindings (principal and granted permission) for a cloud account if the caller is authorized to view it

Get the access report for a cloud account by name

Response contains the grantable permissions that are available for a cloud account when adding a binding in a policy.

Get available permissions for a cloud account resource type

Response will contain the requested domain if the caller is authorized to view it

Get a domain by name

Delete a domain by name

Perform a Patch on a domain by name

Response will contain all the domains the caller is authorized to view

Get all domains

Create a domain

Get all domains based on a query

Response will contain the permissions and associated bindings (principal and granted permission) for a domain if the caller is authorized to view it

Get the access report for a domain by name

Response contains the grantable permissions that are available for a domain when adding a binding in a policy.

Get available permissions for a domain resource type

Response will contain the requested group if the caller is authorized to view it

Get a group by name

Delete a group by name

Perform a Patch on a group by name

Response will contain all the groups the caller is authorized to view

Get all groups

Create a group

Get all groups based on a query

Response will contain the permissions and associated bindings (principal and granted permission) for a group if the caller is authorized to view it

Get the access report for a group by name

Response contains the grantable permissions that are available for a group when adding a binding in a policy.

Get available permissions for a group resource type

Response will contain the requested GVC if the caller is authorized to view it

Get a GVC  by name

Delete a GVC by name

Perform a Patch on a GVC by name

Response will contain all the GVCs the caller is authorized to view

Get all GVCs

Get all GVCs based on a query

Response will contain the permissions and associated bindings (principal and granted permission) for a GVC if the caller is authorized to view it

Get the access report for a GVC by name

Response contains the grantable permissions that are available for a GVC when adding a binding in a policy.

Get available permissions for a GVC resource type

Response will contain the requested identity if the caller is authorized to view it

Get an identity by GVC and name

Delete an identity by GVC and name

Perform a Patch on an identity by name

Get all identities in a GVC

Create an identity

Response will contain all the identities from all the GVCs the caller is authorized to view

Get all identities from all GVCs

Response will contain all the GVC identities the caller is authorized to view

Get all GVC identities based on a query

Response will contain the permissions and associated bindings (principal and granted permission) for an identity if the caller is authorized to view it

Get the access report for an identity by GVC and name

Response contains the grantable permissions that are available for an identity when adding a binding in a policy.

Get available permissions for an identity

Response will contain the requested image if the caller is authorized to view it

Get a image by name

Delete an image by name

Perform a Patch on an image by name

Response will contain all the images the caller is authorized to view

Get all images

Get all images based on a query

Response will contain the permissions and associated bindings (principal and granted permission) for an image if the caller is authorized to view it

Get the access report for an image by name

Response contains the grantable permissions that are available for an image when adding a binding in a policy.

Get available permissions for an image resource type

API	Endpoint URL	OpenAPI Documentation URL
Core	https://api.cpln.io/	https://console.cpln.io/openapi/core
Audit	https://audit.cpln.io/audit	https://console.cpln.io/openapi/audit

​Overview

​Endpoints and OpenAPI Documentation

Overview

Endpoints and OpenAPI Documentation