How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Facets Control Plane API

The Facets Control Plane REST API. 519 paths and 629 operations across blueprints (stacks), environments (clusters), releases, resources, overrides, artifacts and builds, modules, variables and secrets, notifications, cloud and VCS accounts, and RBAC. Authentication is HTTP Basic - your control-plane sign-in email plus a personal access token. Each customer is served from their own control-plane host, so the base URL is templated; the published OpenAPI names the Facets demo tenant because springdoc generates servers[] from the host that served the document.

Facets Control Plane API is published by Facets on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Automation, Infrastructure, Orchestration, and Platform Engineering. The published artifact set on APIs.io includes API documentation, an API reference, a getting-started guide, authentication docs, release notes, and an OpenAPI specification.

This API exposes 629 operations across 519 paths, organized into 62 resource areas, and defines 582 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://facetsdemo.console.facets.cloud.

629 operations 519 paths 582 schemas 54 DELETE314 GET1 HEAD1 OPTIONS5 PATCH177 POST77 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://{account-id}.console.facets.cloud
Authentication
HTTP Basic
Resource Areas
62

Authentication & Security 1

Facets Control Plane API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Basic Authentication

Paths & Operations 629

Across 519 paths, the API surfaces 629 operations — 54 DELETE, 314 GET, 1 HEAD, 1 OPTIONS, 5 PATCH, 177 POST, 77 PUT. They span 62 resource areas, including application-controller, ui-accounts-controller, ui-tekton-action-controller, ui-artifact-routing-rule-controller, ui-artifact-hub-controller, ui-artifactory-controller, ui-artifact-ci-controller, ui-artifacts-controller, and 54 more. Each is listed below with its method, path, parameters, and response codes.

application-controller 13
POST
/api/cc-users
createUserCC body → 200400403404405409500
DELETE
/api/login
login_5 → 200400403404405409500
GET
/api/login
login → 200400403404405409500
HEAD
/api/login
login_1 → 200400403404405409500
OPTIONS
/api/login
login_6 → 200400403404405409500
PATCH
/api/login
login_4 → 200400403404405409500
POST
/api/login
login_2 → 200400403404405409500
PUT
/api/login
login_3 → 200400403404405409500
GET
/api/me
me → 200400403404405409500
GET
/api/users
getUsers → 200400403404405409500
POST
/api/users
createUser body → 200400403404405409500
PUT
/api/users/{userId}
updateUser 1 param body → 200400403404405409500
PUT
/api/users/{userId}/changePassword
changePassword 1 param body → 200400403404405409500
ui-accounts-controller 39
GET
/cc-ui/v1/accounts/
getAllAccounts → 200400403404405409500
POST
/cc-ui/v1/accounts/aws/
createAwsAccount body → 200400403404405409500
POST
/cc-ui/v1/accounts/aws/validate
validateAwsAccount body → 200400403404405409500
PUT
/cc-ui/v1/accounts/aws/{id}
updateAwsAccount 1 param body → 200400403404405409500
POST
/cc-ui/v1/accounts/azure/
createAzureAccount body → 200400403404405409500
POST
/cc-ui/v1/accounts/azure/validate
validateAzureAccount body → 200400403404405409500
PUT
/cc-ui/v1/accounts/azure/{id}
updateAzureAccount 1 param body → 200400403404405409500
POST
/cc-ui/v1/accounts/bitbucket/
createBitBucketAccount body → 200400403404405409500
POST
/cc-ui/v1/accounts/bitbucket/validate
validateBitbucketAccount body → 200400403404405409500
PUT
/cc-ui/v1/accounts/bitbucket/{id}
updateBitBucketAccount 1 param body → 200400403404405409500
POST
/cc-ui/v1/accounts/coder/
createCoderAccount body → 200400403404405409500
PUT
/cc-ui/v1/accounts/coder/{id}
updateCoderAccount 1 param body → 200400403404405409500
POST
/cc-ui/v1/accounts/gcp/
createGcpAccount body → 200400403404405409500
POST
/cc-ui/v1/accounts/gcp/validate
validateGcpAccount body → 200400403404405409500
PUT
/cc-ui/v1/accounts/gcp/{id}
updateGcpAccount 1 param body → 200400403404405409500
POST
/cc-ui/v1/accounts/get-organisations
getVCSOrganisations body → 200400403404405409500
POST
/cc-ui/v1/accounts/github/
createGitHubAccount body → 200400403404405409500
POST
/cc-ui/v1/accounts/github/validate
validateGithubAccount body → 200400403404405409500
PUT
/cc-ui/v1/accounts/github/{id}
updateGitHubAccount 1 param body → 200400403404405409500
POST
/cc-ui/v1/accounts/gitlab/
createGitLabAccount body → 200400403404405409500
POST
/cc-ui/v1/accounts/gitlab/validate
validateGitlabAccount body → 200400403404405409500
PUT
/cc-ui/v1/accounts/gitlab/{id}
updateGitLabAccount 1 param body → 200400403404405409500
POST
/cc-ui/v1/accounts/kubernetes/
createKubernetesAccount body → 200400403404405409500
POST
/cc-ui/v1/accounts/kubernetes/validate
validateKubernetesAccount body → 200400403404405409500
PUT
/cc-ui/v1/accounts/kubernetes/{id}
updateKubernetesAccount 1 param body → 200400403404405409500
POST
/cc-ui/v1/accounts/link-cloud
requestCloudAccountLinking body → 200400403404405409500
POST
/cc-ui/v1/accounts/link-vcs
requestVCSLinking body → 200400403404405409500
GET
/cc-ui/v1/accounts/name/{name}
getAccountByName 1 param → 200400403404405409500
GET
/cc-ui/v1/accounts/stack/{stackName}/token-details
getVCSTokenDetailsByStackName 1 param → 200400403404405409500
GET
/cc-ui/v1/accounts/token-details
getAllVCSTokenDetails → 200400403404405409500
POST
/cc-ui/v1/accounts/token-details/refresh
refreshAllVCSTokenDetails → 200400403404405409500
GET
/cc-ui/v1/accounts/type/{type}
getAccountsByType 1 param → 200400403404405409500
GET
/cc-ui/v1/accounts/vcs-orgs/{accountId}
getVcsOrganizationsByAccountId 1 param → 200400403404405409500
PATCH
/cc-ui/v1/accounts/vcs/{id}
updateVCSAccount 1 param body → 200400403404405409500
GET
/cc-ui/v1/accounts/{accountId}/workspaces/{workspace}/projects
getBitbucketProjectsForWorkspace 2 params → 200400403404405409500
DELETE
/cc-ui/v1/accounts/{id}
deleteAccount 1 param → 200400403404405409500
GET
/cc-ui/v1/accounts/{id}
getAccount 1 param → 200400403404405409500
GET
/cc-ui/v1/accounts/{id}/github-app/permission-status
getGithubAppPermissionStatus 2 params → 200400403404405409500
PUT
/cc-ui/v1/accounts/{id}/labels
Set an account's tags
setAccountLabels 1 param body → 200400403404405409500
ui-tekton-action-controller 5
GET
/cc-ui/v1/actions
Get Actions
getActions 3 params → 200400403404405409500
POST
/cc-ui/v1/actions/run
Run Multiple Actions
runActions body → 200400403404405409500
GET
/cc-ui/v1/actions/runs/{actionRunName}/steps/{stepName}/logs
Get Step Logs
getStepLogs 2 params → 200400403404405409500
GET
/cc-ui/v1/actions/runs/{actionRunName}/upload
Download Upload for Action Run
downloadUpload 1 param → 200400403404405409500
GET
/cc-ui/v1/actions/{actionName}/runs
Get Action Runs
getActionRuns 1 param → 200400403404405409500
ui-artifact-routing-rule-controller 7
GET
/cc-ui/v1/artifact-routing-rule
getAllArtifactRoutingRules 2 params → 200400403404405409500
POST
/cc-ui/v1/artifact-routing-rule
addArtifactRoutingRule body → 200400403404405409500
PUT
/cc-ui/v1/artifact-routing-rule
updateArtifactRoutingRule body → 200400403404405409500
GET
/cc-ui/v1/artifact-routing-rule/operators
getAllOperators → 200400403404405409500
POST
/cc-ui/v1/artifact-routing-rule/test
testRuleForBranchName 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/artifact-routing-rule/{ruleId}
deleteArtifactRoutingRule 1 param → 200400403404405409500
GET
/cc-ui/v1/artifact-routing-rule/{ruleId}
getArtifactRoutingRule 1 param → 200400403404405409500
ui-artifact-hub-controller 2
GET
/cc-ui/v1/artifactHub/packages/{packageId}/values
getHelmValues 2 params → 200400403404405409500
GET
/cc-ui/v1/artifactHub/search-packages
searchPackages 7 params → 200400403404405409500
ui-artifactory-controller 17
GET
/cc-ui/v1/artifactories
getAllArtifactories → 200400403404405409500
POST
/cc-ui/v1/artifactories
createECRArtifactory body → 200400403404405409500
POST
/cc-ui/v1/artifactories/link-container-registry
requestArtifactoryLinking body → 200400403404405409500
POST
/cc-ui/v1/artifactories/mirrors
createArtifactoryMirror body → 200400403404405409500
GET
/cc-ui/v1/artifactories/name/{name}
getArtifactoryByName 1 param → 200400403404405409500
GET
/cc-ui/v1/artifactories/name/{name}/repos
getRepositoriesByArtifactoryName 2 params → 200400403404405409500
GET
/cc-ui/v1/artifactories/name/{name}/tags
getTagsByArtifactoryName 3 params → 200400403404405409500
POST
/cc-ui/v1/artifactories/others
createBasicDockerArtifactory body → 200400403404405409500
POST
/cc-ui/v1/artifactories/others/{artifactoryId}
updateBasicDockerArtifactory 1 param body → 200400403404405409500
GET
/cc-ui/v1/artifactories/stack/{stackName}
getAllArtifactoriesForStack 1 param → 200400403404405409500
DELETE
/cc-ui/v1/artifactories/v2/{artifactoryId}
deleteArtifactory 1 param → 200400403404405409500
DELETE
/cc-ui/v1/artifactories/{artifactoryId}
deleteECRArtifactory 1 param → 200400403404405409500
GET
/cc-ui/v1/artifactories/{artifactoryId}
getArtifactoryById 1 param → 200400403404405409500
POST
/cc-ui/v1/artifactories/{artifactoryId}
updateECRArtifactory 1 param body → 200400403404405409500
POST
/cc-ui/v1/artifactories/{artifactoryId}/associate-projects
associateStacks 1 param body → 200400403404405409500
GET
/cc-ui/v1/artifactories/{artifactoryId}/repos
getRepositories 1 param → 200400403404405409500
GET
/cc-ui/v1/artifactories/{artifactoryId}/tags
getTags 2 params → 200400403404405409500
ui-artifact-ci-controller 9
GET
/cc-ui/v1/artifacts-ci
getAllArtifactsCI → 200400403404405409500
POST
/cc-ui/v1/artifacts-ci
createArtifactCI body → 200400403404405409500
GET
/cc-ui/v1/artifacts-ci/blueprint/{stackName}
getArtifactCisByStack 1 param → 200400403404405409500
POST
/cc-ui/v1/artifacts-ci/bulk-edit-workflow
bulkEditWorkflow body → 200400403404405409500
GET
/cc-ui/v1/artifacts-ci/name/{ciName}
getArtifactCiByName 1 param → 200400403404405409500
DELETE
/cc-ui/v1/artifacts-ci/{ciId}
deleteArtifactCI 1 param → 200400403404405409500
GET
/cc-ui/v1/artifacts-ci/{ciId}
getArtifactCI 1 param → 200400403404405409500
PUT
/cc-ui/v1/artifacts-ci/{ciId}
updateArtifactCI 1 param body → 200400403404405409500
GET
/cc-ui/v1/artifacts-ci/{ciName}/artifacts
getArtifactsForCI 1 param → 200400403404405409500
ui-artifacts-controller 20
POST
/cc-ui/v1/artifacts/attach-image-via-register
attachImageViaRegister body → 200400403404405409500
GET
/cc-ui/v1/artifacts/cluster/{clusterId}/application/{applicationName}
getArtifactByApplicationName 2 params → 200400403404405409500
GET
/cc-ui/v1/artifacts/cluster/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}
getArtifactsByResourceNameAndResourceType 3 params → 200400403404405409500
POST
/cc-ui/v1/artifacts/clusterId/{clusterId}/currentReleaseStream/{currentReleaseStream}/updatedReleaseStream/{updatedReleaseStream}/updateStream
updateReleaseStream 5 params → 200400403404405409500
GET
/cc-ui/v1/artifacts/metadata/keys
getMetadataKeys → 200400403404405409500
POST
/cc-ui/v1/artifacts/promote
promoteArtifactByArtifactCiName 2 params → 200400403404405409500
POST
/cc-ui/v1/artifacts/push
pushArtifact body → 200400403404405409500
POST
/cc-ui/v1/artifacts/pushCredentials/{stackName}/{appName}
generateArtifactPushCredentials_1 2 params → 200400403404405409500
POST
/cc-ui/v1/artifacts/pushCredentialsV2/artifactName/{artifactName}/registrationType/{registrationType}/value/{registrationValue}
generateArtifactPushCredentialsV2 3 params → 200400403404405409500
POST
/cc-ui/v1/artifacts/pushCredentialsV3/artifactName/{artifactName}
generateArtifactPushCredentialsV3 2 params → 200400403404405409500
PUT
/cc-ui/v1/artifacts/reclassify
reclassifyArtifacts 1 param → 200400403404405409500
POST
/cc-ui/v1/artifacts/registerdeprecated
registerArtifact body → 200400403404405409500
POST
/cc-ui/v1/artifacts/register-by-env
registerArtifactByEnv body → 200400403404405409500
POST
/cc-ui/v1/artifacts/register-by-release-stream
registerArtifactByReleaseStream body → 200400403404405409500
POST
/cc-ui/v1/artifacts/register-saas
registerArtifactSaas_1 body → 200400403404405409500
POST
/cc-ui/v1/artifacts/registerV2
registerArtifactV2 body → 200400403404405409500
POST
/cc-ui/v1/artifacts/upload
uploadArtifactsZip body → 200400403404405409500
DELETE
/cc-ui/v1/artifacts/{artifactId}
deleteArtifact 1 param → 200400403404405409500
POST
/cc-ui/v1/artifacts/{ciId}/promote/{artifactId}
promoteArtifact 2 params → 200400403404405409500
GET
/cc-ui/v1/artifacts/{clusterId}
getArtifactByClusterId 1 param → 200400403404405409500
ui-audit-logs-controller 3
GET
/cc-ui/v1/audit-logs
getAuditLogs 11 params → 200400403404405409500
GET
/cc-ui/v1/audit-logs/entities
List audit entity types
getAuditEntities → 200400403404405409500
GET
/cc-ui/v1/audit-logs/entity-actions
List audit entity actions
getAuditEntityActions 1 param → 200400403404405409500
ui-aws-cluster-controller 6
POST
/cc-ui/v1/aws/clusters
Create a new Environment for a blueprint
createClusterUsingPOST2 body → 200400403404405409500
POST
/cc-ui/v1/aws/clusters/configure/{clusterId}
configureDraftCluster_2 1 param body → 200400403404405409500
POST
/cc-ui/v1/aws/clusters/onboard-customer
onboardCustomer body → 200400403404405409500
GET
/cc-ui/v1/aws/clusters/validate-vpcId
validateVpcId_1 3 params → 200400403404405409500
GET
/cc-ui/v1/aws/clusters/{clusterId}
getClusterUsingGET2 1 param → 200400403404405409500
PUT
/cc-ui/v1/aws/clusters/{clusterId}
updateClusterUsingPUT2 1 param body → 200400403404405409500
ui-azure-cluster-controller 5
POST
/cc-ui/v1/azure/clusters
createAzureCluster body → 200400403404405409500
POST
/cc-ui/v1/azure/clusters/configure/{clusterId}
configureDraftCluster_1 1 param body → 200400403404405409500
GET
/cc-ui/v1/azure/clusters/validate-vnet
validateVnet 3 params → 200400403404405409500
GET
/cc-ui/v1/azure/clusters/{clusterId}
getAzureCluster 1 param → 200400403404405409500
PUT
/cc-ui/v1/azure/clusters/{clusterId}
updateAzureCluster 1 param body → 200400403404405409500
ui-billing-controller 4
POST
/cc-ui/v1/billing/buy-support-plan
buySupportPlan 2 params → 200400403404405409500
GET
/cc-ui/v1/billing/manage-billing
startStripeCustomerPortalSession 1 param → 200400403404405409500
GET
/cc-ui/v1/billing/metadata
getBillingMetadata → 200400403404405409500
GET
/cc-ui/v1/billing/report-usage
reportUsage → 200400403404405409500
Blueprint Pull Requests 5

Native Facets blueprint pull-request (branch) lifecycle APIs

GET
/cc-ui/v1/blueprint-pull-requests/{stackName}
List blueprint pull requests
listPullRequests 1 param → 200400403404405409500
POST
/cc-ui/v1/blueprint-pull-requests/{stackName}
Create a blueprint pull request
createPullRequest 1 param body → 200400403404405409500
GET
/cc-ui/v1/blueprint-pull-requests/{stackName}/{branch}
Get the pull request for a branch
getPullRequest 2 params → 200400403404405409500
POST
/cc-ui/v1/blueprint-pull-requests/{stackName}/{branch}/close
Close a blueprint pull request
closePullRequest 2 params → 200400403404405409500
POST
/cc-ui/v1/blueprint-pull-requests/{stackName}/{branch}/merge
Merge a blueprint pull request
mergePullRequest 2 params → 200400403404405409500
ui-ci-cd-controller 11
POST
/cc-ui/v1/ci-cd
Save CI/CD Details
saveCiCdDetails body → 200400403404405409500
PUT
/cc-ui/v1/ci-cd/attach
Attach Rule and Workflow
attachRuleAndWorkflow body → 200400403404405409500
GET
/cc-ui/v1/ci-cd/ci-name/{ciName}/resources
Get Resources by CI Name
getResourcesByCiName 1 param → 200400403404405409500
DELETE
/cc-ui/v1/ci-cd/ci/{ciName}
Delete CI Integration
deleteCiIntegration 1 param → 200400403404405409500
GET
/cc-ui/v1/ci-cd/ci/{ciName}
Get CI-level CI/CD Configuration
getCiLevelCiCdDetails 1 param → 200400403404405409500
POST
/cc-ui/v1/ci-cd/ci/{ciName}/custom
Set Custom CI/CD Configuration
saveCustomCiCd 1 param body → 200400403404405409500
PUT
/cc-ui/v1/ci-cd/detach
Detach Rule and Workflow
detachRuleAndWorkflow body → 200400403404405409500
POST
/cc-ui/v1/ci-cd/pushCredentials
Generate Artifact Push Credentials
generateArtifactPushCredentials body → 200400403404405409500
POST
/cc-ui/v1/ci-cd/register
Register Artifact SaaS
registerArtifactSaas body → 200400403404405409500
DELETE
/cc-ui/v1/ci-cd/{stackName}
Reset CI/CD Details
resetCiCdDetails 1 param → 200400403404405409500
GET
/cc-ui/v1/ci-cd/{stackName}
Get CI/CD Details
getCiCdDetails 1 param → 200400403404405409500
ui-common-cluster-controller 58
POST
/cc-ui/v1/clusters/draft-cluster
createDraftCluster_1 body → 200400403404405409500
PUT
/cc-ui/v1/clusters/draft-cluster/{clusterId}
updateDraftCluster 1 param body → 200400403404405409500
GET
/cc-ui/v1/clusters/stack/{stackName}/cluster/{clusterName}/info
Get cluster info by stack name and cluster name
getClusterInfoByName 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{baseClusterId}/base-env-in-use-namespaces
getNamespacesInUseByDependentClusters_1 1 param → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}
deleteCluster 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}
getClusterCommon 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/alerts
getAlerts 1 param → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/alerts/silence/{silenceId}
removeSilence 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/attach-image
attachImage 1 param body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/availability-schedule
getAvailabilitySchedules 1 param → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/availability-schedule
createAvailabilitySchedule 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/availability-schedule/{availabilityScheduleId}
deleteAvailabilitySchedule 2 params → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/availability-schedule/{scheduleId}
updateAvailabilitySchedules 2 params body → 200400403404405409500
PATCH
/cc-ui/v1/clusters/{clusterId}/branch
updateClusterBranch 1 param body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/cluster-metadata
getClusterMetadata 1 param → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/copy-configurations-selective
Copy configurations from one cluster to another selectively
copyConfigurationsSelective 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/detachImage
detachImage 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/force
deleteClusterForce 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/info
getClusterInfo 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/intent/{intent}/flavor/{flavor}/input
Get module inputs for a cluster
getModuleInputs_1 4 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8sCredentials
getK8sCredentials 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/kubeconfig
getKubeConfig 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/kubeconfig/refresh
refreshKubeConfig 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/match-modules
getMatchedModules 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/open-alerts
getOpenAlerts 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/overrides
getOverrides_1 1 param → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/overrides/{resourceType}/{resourceName}deprecated
deleteOverrides 3 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/pause-release
pauseRelease 1 param body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/providedResources
getProvidedResources 1 param → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/providedResources
upsertProvidedResources 1 param body → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/resource-enable-disable
bulkEnableDisableResources 1 param body → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/resource-inherit-from-base
bulkEditInheritFromBaseForResources_1 1 param body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resource-stats
getResourceStats 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceDetails
resourceDetails 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}/add-ons
Get add-ons for a resource in a cluster
getAddOnModules_1 4 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}/release-impacts
getReleaseImpacts 12 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/schedule
getClusterSchedules 1 param → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/schedule
addClusterSchedules 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/schedule/{clusterScheduleId}
deleteClusterSchedule 2 params → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/schedule/{clusterScheduleId}
updateClusterSchedules 2 params body → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/setClusterCode
setClusterCode 1 param → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/silence-alerts
silenceAlerts 1 param body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/templateInputs/
getAllTemplateInputs 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/templateInputs/{inputType}/items
getTemplateInputs 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/templateInputs/{inputType}/items
createTemplateInputs 2 params body → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/templateInputs/{inputType}/items/{uid}
deleteTemplateInputs 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/templateInputs/{inputType}/items/{uid}
getTemplateInputByUid 3 params → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/templateInputs/{inputType}/items/{uid}
updateTemplateInput 3 params body → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/tools-config
deleteToolsConfig 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/tools-config
getToolsConfig 1 param → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/tools-config
addToolsConfig 1 param body → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/tools-config/{toolsConfigId}
editToolsConfig 2 params body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/variable-counts
getVariableCounts 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/vars
getVars 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/vars-with-secrets
getVarsWithSecrets 1 param → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/vars/upsert
upsertVars 1 param body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/varsWithStatus
getVarsWithStatus 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/vpn-profile
getVPNProfile 1 param → 200400403404405409500
ui-application-controller 21
PUT
/cc-ui/v1/clusters/{clusterId}/abort
abort 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/argo-info
getArgoRolloutInfo 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/overrides
Write the overrides of several resources
postResourceOverrides 2 params body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/pods/{podName}/events
getEvents 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/pods/{podName}/logs
logs 3 params → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/promote
promote 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceName/{applicationName}/hpa
getHPA 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceName/{applicationName}/ingresses
getIngresses 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceName/{applicationName}/pods
listPods 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}
getResourceByNameV2 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}/deployed-commit-id
getDeployedCommitIdForResource 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}/overrides
getResourceOverrideObject 3 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}/overrides
postResourceOverrideObject 5 params body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}/resource-history
getResourceHistory 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}/resource-out-properties
getResourceOutProperties 3 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/restart/{applicationName}
rollingRestart 3 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/sync-with-git
Sync cluster with git.
clusterSyncWithGit 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/validate
runValidation 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/validation-errors
getValidations 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/{resourceType}/{appName}deprecated
getResourceByName 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/{resourceType}/{appName}/overridesdeprecated
getApplicationOverrides 3 params → 200400403404405409500
Blueprint Diff 1
GET
/cc-ui/v1/clusters/{clusterId}/blueprint/content
Get blueprint resource file content at a specific commit
getBlueprintContent 4 params → 200400403404405409500
ui-deployment-controller 34
GET
/cc-ui/v1/clusters/{clusterId}/deployments
getDeployments 1 param → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments
createDeployment 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/deployments/destroy
destroyCluster 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/latest-successful-release
getLatestRelease 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/latest-successful-release/{application}
getLatestReleaseByApplication 2 params → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/deployments/launch
launchCluster 1 param → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/maintenance
triggerMaintenanceRelease 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/overview
getDeploymentsOverview 1 param → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/deployments/qa/{executionId}/abortSuite
abortAutomationSuite 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/recipes/deployment/hotfix
runHotfixDeploymentRecipe 10 params body → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/deployments/release
release 7 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/release-changes/bulk
getReleaseChangesBulk 1 param body → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/deployments/releaseV2/{releaseType}
releaseV2 9 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/search
searchDeployments 11 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/simulate
simulate 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/state
getClusterState 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/stats
getDeploymentStats 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/terraform-export
triggerTerraformExport 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/trace-id/{releaseTraceId}
getDeploymentByReleaseTraceId 2 params → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/deployments/unlock
stateUnlock 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}
getDeployment 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/abort
abortRelease 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/approveRelease
approveRelease 2 params → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/attach-labels
attachLabels 2 params body → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/download-plan
downloadPlan 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/download-terraform-export
downloadTerraformExport 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/logs
getDeploymentLogs 4 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/logs/stream
streamDeploymentLogs 3 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/rejectRelease
rejectRelease 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/release-changes
getReleaseChanges 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/release-metadata
getReleaseMetadata 2 params → 200400403404405409500
PUT
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/signoff
signOffDeployment 2 params → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/upload-release-metadata
uploadReleaseMetadata 2 params body → 200400403404405409500
POST
/cc-ui/v1/clusters/{clusterId}/deployments/{deploymentId}/{resourceType}/{resourceName}/rollback-plan
triggerRollbackPlanRelease 4 params → 200400403404405409500
ui-kubernetes-explorer-controller 23
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/configMaps
listConfigMapByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/configMaps/{configMapName}
getConfigMapData 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/cronJobs
listCronJobByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/daemonSets
listDaemonSetsByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/deployments
listDeploymentsByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/deployments/{deploymentName}
getPodsForDeployment 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/hpa
listHpaByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/ingress-rules
getAllIngressRulesForCluster 1 param → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/ingresses
listIngressesByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/jobs
listJobsByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/pods
listPodsByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/pods/{podName}/{containerName}/logs
containerLogs 5 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/pv
listPVByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/pvc
listPVCByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/replicasets
listReplicasetsByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/secrets
listSecretsByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/secrets/{secretName}
getSecretsData 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/services
listServicesByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/statefulsets
listStatefulsetsLabelsByLabels 2 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/{k8sResourceType}/{k8sResourceName}/events
listEventsByK8sResource 4 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/{k8sResourceType}/{k8sResourceName}/manifest
getManifest 4 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/{podName}/containers
listContainersInPod 3 params → 200400403404405409500
GET
/cc-ui/v1/clusters/{clusterId}/k8s-explorer/{podName}/v2/containers
listContainersInPodV2 3 params → 200400403404405409500
ui-queued-release-controller 2
GET
/cc-ui/v1/clusters/{clusterId}/queued-releases/
getAllQueuedReleases 1 param → 200400403404405409500
DELETE
/cc-ui/v1/clusters/{clusterId}/queued-releases/{queuedReleaseId}
deleteById 2 params → 200400403404405409500
ui-coder-controller 7
GET
/cc-ui/v1/coder/stack/{stackName}/coder-eligibility
identifyCoderLaunchEligible 1 param → 200400403404405409500
POST
/cc-ui/v1/coder/stack/{stackName}/existing-branch
createWorkspaceWithExistingBranch_1 1 param body → 200400403404405409500
POST
/cc-ui/v1/coder/stack/{stackName}/new-branch
createWorkspaceWithNewBranch_1 1 param body → 200400403404405409500
POST
/cc-ui/v1/coder/stack/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/existing-branch
createWorkspaceWithExistingBranch 3 params body → 200400403404405409500
POST
/cc-ui/v1/coder/stack/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/new-branch
createWorkspaceWithNewBranch 3 params body → 200400403404405409500
GET
/cc-ui/v1/coder/stack/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/workspaces
getAll_4 3 params → 200400403404405409500
GET
/cc-ui/v1/coder/stack/{stackName}/workspaces
getAll_3 1 param → 200400403404405409500
ui-custom-content-controller 5
POST
/cc-ui/v1/content/files
createContentFile body → 200400403404405409500
GET
/cc-ui/v1/content/files/selectors/{contentType}
getContentFilesBySelectors 5 params → 200400403404405409500
DELETE
/cc-ui/v1/content/files/{contentId}
deleteContentFile 1 param → 200400403404405409500
PUT
/cc-ui/v1/content/files/{contentId}
updateContentFile 1 param body → 200400403404405409500
POST
/cc-ui/v1/content/files/{contentId}/render
renderContent 1 param body → 200400403404405409500
ui-cloud-cost-explorer-controller 4
GET
/cc-ui/v1/cost-explorer/aws/enabled
isAwsCostExplorerEnabled → 200400403404405409500
GET
/cc-ui/v1/cost-explorer/service-wise-cost/{clusterId}
getServiceWiseCost 3 params → 200400403404405409500
GET
/cc-ui/v1/cost-explorer/stack/{stackName}/daily-cost
getDailyCloudCost 4 params → 200400403404405409500
GET
/cc-ui/v1/cost-explorer/sync-cost
syncCloudCost → 200400403404405409500
ui-custom-role-controller 6
GET
/cc-ui/v1/custom-role
getAllCustomRoles → 200400403404405409500
POST
/cc-ui/v1/custom-role
createCustomRole body → 200400403404405409500
GET
/cc-ui/v1/custom-role/roles
getAllRoles → 200400403404405409500
DELETE
/cc-ui/v1/custom-role/{roleName}
deleteCustomRole 1 param → 200400403404405409500
GET
/cc-ui/v1/custom-role/{roleName}
getCustomRole 1 param → 200400403404405409500
PUT
/cc-ui/v1/custom-role/{roleName}
updateCustomRole 1 param body → 200400403404405409500
ui-delivery-pipeline-controller 2
GET
/cc-ui/v1/delivery-pipeline/{stackName}
getDeliveryPipeline 1 param → 200400403404405409500
PUT
/cc-ui/v1/delivery-pipeline/{stackName}
updateDeliveryPipeline 1 param body → 200400403404405409500
Blueprint Designer V2 11

V2 APIs for blueprint designer write operations

POST
/cc-ui/v1/designer/v2/templates/{templateName}/sync
Sync blueprints with template
syncSpecifiedBlueprintsWithTemplates_1 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/designer/v2/{stackName}/resources
Delete resources
deleteResources_1 1 param body → 200400403404405409500
POST
/cc-ui/v1/designer/v2/{stackName}/resources
Create resources
createResources_1 1 param body → 200400403404405409500
PUT
/cc-ui/v1/designer/v2/{stackName}/resources
Update resources
updateResources_1 1 param body → 200400403404405409500
PUT
/cc-ui/v1/designer/v2/{stackName}/resources/inherit-from-base
Bulk set inherit-from-base
bulkInheritFromBase 1 param body → 200400403404405409500
PUT
/cc-ui/v1/designer/v2/{stackName}/resources/rename
Rename a resource
renameResource_1 1 param body → 200400403404405409500
PUT
/cc-ui/v1/designer/v2/{stackName}/resources/toggle
Bulk enable/disable resources
bulkToggleResources 1 param body → 200400403404405409500
POST
/cc-ui/v1/designer/v2/{stackName}/templates/{templateName}/apply
Apply template
applyTemplate_1 2 params body → 200400403404405409500
DELETE
/cc-ui/v1/designer/v2/{stackName}/variables
Delete variables
deleteVariables_1 1 param body → 200400403404405409500
POST
/cc-ui/v1/designer/v2/{stackName}/variables
Add variables
addVariables_1 1 param body → 200400403404405409500
PUT
/cc-ui/v1/designer/v2/{stackName}/variables
Update variables
updateVariables_1 1 param body → 200400403404405409500
Blueprint Hook 3

Manage a blueprint hook (e.g. the pre-release approval hook)

DELETE
/cc-ui/v1/designer/v2/{stackName}/hooks/{type}
Remove a blueprint hook
deleteHook 4 params → 200400403404405409500
GET
/cc-ui/v1/designer/v2/{stackName}/hooks/{type}
Get a blueprint hook
getHook 3 params → 200400403404405409500
PUT
/cc-ui/v1/designer/v2/{stackName}/hooks/{type}
Install or replace a blueprint hook
setHook 2 params body → 200400403404405409500
ui-blueprint-designer-controller 29
GET
/cc-ui/v1/designer/{stackName}/branch-list
listBranches_1 1 param → 200400403404405409500
DELETE
/cc-ui/v1/designer/{stackName}/branch/{branch}
deleteResources 2 params body → 200400403404405409500
POST
/cc-ui/v1/designer/{stackName}/branch/{branch}
createResources 2 params body → 200400403404405409500
PUT
/cc-ui/v1/designer/{stackName}/branch/{branch}
updateResources 3 params body → 200400403404405409500
PUT
/cc-ui/v1/designer/{stackName}/branch/{branch}/mustache
Update resources with mustache templates
updateMustacheResources 2 params body → 200400403404405409500
PUT
/cc-ui/v1/designer/{stackName}/branch/{branch}/rename
renameResource 2 params body → 200400403404405409500
PUT
/cc-ui/v1/designer/{stackName}/branch/{branch}/resource-enable-disable
bulkEditDisabledForResources_1 2 params body → 200400403404405409500
PUT
/cc-ui/v1/designer/{stackName}/branch/{branch}/resource-inherit-from-base
bulkEditInheritFromBaseForResources 2 params body → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/intent/{intent}/flavor/{flavor}/input
getModuleInputs 4 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/intent/{intent}/flavor/{flavor}/output-providers
listProvidersExposedByModule 3 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/pulls
getPullRequests_1 6 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/ref-autocomplete-data-v2
Get autocomplete data with module-specific output trees
getAutocompleteDataV2 1 param → 200400403404405409500
PUT
/cc-ui/v1/designer/{stackName}/resource-enable-disable
bulkEditDisabledForResources 1 param body → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/add-ons
Get add ons for this resource
getAddOnModules 4 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/branch-list
listBranches 3 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/pulls
getPullRequests 8 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/workflow-runs
getWorkflowRuns_1 10 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/workflows
getWorkflows_1 3 params → 200400403404405409500
DELETE
/cc-ui/v1/designer/{stackName}/variables
deleteVariables 1 param body → 200400403404405409500
POST
/cc-ui/v1/designer/{stackName}/variables
addVariables 1 param body → 200400403404405409500
PUT
/cc-ui/v1/designer/{stackName}/variables
updateVariables 1 param body → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/variables/usages
Get usages of all secrets and variables for a stack
getAllVariableUsages 1 param → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/variables/{variableName}/usages
Get usages of a specific secret or variable
getVariableUsages 2 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/workflow-runs
getWorkflowRuns 8 params → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/workflows
getWorkflows 1 param → 200400403404405409500
GET
/cc-ui/v1/designer/{stackName}/{branchName}/files
getDesignerResources 2 params → 200400403404405409500
POST
/cc-ui/v1/designer/{stackName}/{branch}/create-branch
createBranch 2 params → 200400403404405409500
POST
/cc-ui/v1/designer/{stackName}/{templateName}/apply
applyTemplate 4 params → 200400403404405409500
POST
/cc-ui/v1/designer/{templateName}/sync
syncSpecifiedBlueprintsWithTemplates 1 param body → 200400403404405409500
ui-domain-mapping-controller 4
DELETE
/cc-ui/v1/domain-mapping/clusterId/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}
deleteDomainMapping 4 params → 200400403404405409500
GET
/cc-ui/v1/domain-mapping/clusterId/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}
getAllDomains 3 params → 200400403404405409500
POST
/cc-ui/v1/domain-mapping/clusterId/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}
addDomainMapping 3 params body → 200400403404405409500
PUT
/cc-ui/v1/domain-mapping/clusterId/{clusterId}/resourceType/{resourceType}/resourceName/{resourceName}
updateDomainMapping 3 params body → 200400403404405409500
ui-dropdowns-controller 30
GET
/cc-ui/v1/dropdown/cluster-resources-lite
List cluster resources (lite)
getAllResourcesByClusterLite 1 param → 200400403404405409500
POST
/cc-ui/v1/dropdown/cluster/{clusterId}/affected-resources
getAffectedResourcesByCluster 1 param body → 200400403404405409500
GET
/cc-ui/v1/dropdown/cluster/{clusterId}/resources
getAllResources 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/cluster/{clusterId}/resources-info
getAllResourcesByCluster 4 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/cluster/{clusterId}/{resourceType}/{resourceName}/resource-info
getResourceByClusterId 4 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/file
getFileFromFacetsModules 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/getAllPermissions
getAllPermissions → 200400403404405409500
POST
/cc-ui/v1/dropdown/logs/cluster/{clusterId}
syncClusterHistory 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/logs/cluster/{clusterId}/resourceName/{resourceName}/resourceType/{resourceType}
getGitHistoryForResource 3 params → 200400403404405409500
POST
/cc-ui/v1/dropdown/logs/substack
syncSubstackGitHistory 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/releaseStreams
getReleaseStreams → 200400403404405409500
GET
/cc-ui/v1/dropdown/rolePermissions/{role}
getRolePermissions 1 param → 200400403404405409500
GET
/cc-ui/v1/dropdown/stack-resources-lite
List stack resources (lite)
getAllResourcesByStackLite 1 param → 200400403404405409500
POST
/cc-ui/v1/dropdown/stack/{stackName}/affected-resources
getAffectedResourcesByStack 1 param body → 200400403404405409500
GET
/cc-ui/v1/dropdown/stack/{stackName}/all-cluster-resources
getAllResourcesForAllClusterOfStack 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/stack/{stackName}/resources-info
getAllResourcesByStack 4 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/stack/{stackName}/service/{serviceName}/overview
getServiceOverview 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/stack/{stackName}/{resourceType}/{resourceName}/cluster-resources-info
getAllClusterResourcesByStack 3 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/stack/{stackName}/{resourceType}/{resourceName}/resource-info
getResourceByStack 4 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/vcs
getAllVCS → 200400403404405409500
GET
/cc-ui/v1/dropdown/{cloud}/region/{region}/availability-zones
getAzForRegionByCloud 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/{cloud}/regionsdeprecated
getRegions 1 param → 200400403404405409500
GET
/cc-ui/v1/dropdown/{cloud}/regions-v2
getRegionsV2 1 param → 200400403404405409500
GET
/cc-ui/v1/dropdown/{clusterId}/cloud/{cloud}/launch-dag
getLaunchDAG 4 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/{clusterId}/resource-type/{resourceType}/connection-strings
getConnectionStringsByResourceType 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/{clusterId}/{resourceType}
getApplicationListByClusterIdAndResourceName 2 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/{stackName}/output-references
getOutputReferencesByType 4 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/{stackName}/output/{outputType}/referencesdeprecated
getOutputReferences 4 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/resource-historydeprecated
getResourceHistoriesByStack 3 params → 200400403404405409500
GET
/cc-ui/v1/dropdown/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/resource-history-overview
getResourceHistoryOverviewByStack 3 params → 200400403404405409500
ui-environment-controller 4
POST
/cc-ui/v1/environments
createEnvironment body → 200400403404405409500
POST
/cc-ui/v1/environments/configure/{clusterId}
configureDraftEnvironment 1 param body → 200400403404405409500
GET
/cc-ui/v1/environments/{clusterId}
getEnvironment 1 param → 200400403404405409500
PUT
/cc-ui/v1/environments/{clusterId}
updateEnvironment 1 param body → 200400403404405409500
ui-gcp-cluster-controller 5
POST
/cc-ui/v1/gcp/clusters
createGCPCluster body → 200400403404405409500
POST
/cc-ui/v1/gcp/clusters/configure/{clusterId}
configureDraftCluster 1 param body → 200400403404405409500
GET
/cc-ui/v1/gcp/clusters/validate-vpcId
validateVpcId 2 params → 200400403404405409500
GET
/cc-ui/v1/gcp/clusters/{clusterId}
getGCPCluster 1 param → 200400403404405409500
PUT
/cc-ui/v1/gcp/clusters/{clusterId}
updateGCPCluster 1 param body → 200400403404405409500
Intent Management 3
GET
/cc-ui/v1/intents
getAllIntents → 200400403404405409500
POST
/cc-ui/v1/intents
createOrUpdateIntent body → 200400403404405409500
DELETE
/cc-ui/v1/intents/{name}
deleteIntent 1 param → 200400403404405409500
ui-k-8s-cluster-controller 4
POST
/cc-ui/v1/kubernetes/clusters
createK8sCluster body → 200400403404405409500
POST
/cc-ui/v1/kubernetes/clusters/configure/{clusterId}
createDraftCluster 1 param body → 200400403404405409500
GET
/cc-ui/v1/kubernetes/clusters/{clusterId}
getK8sCluster 1 param → 200400403404405409500
PUT
/cc-ui/v1/kubernetes/clusters/{clusterId}
updateK8sCluster 1 param body → 200400403404405409500
Label Management 5

APIs for managing labels

GET
/cc-ui/v1/labels
Get all labels
getAllLabels 1 param → 200400403404405409500
POST
/cc-ui/v1/labels
Create a new label
createLabel body → 200400403404405409500
DELETE
/cc-ui/v1/labels/{labelId}
Delete a label
deleteLabel 1 param → 200400403404405409500
GET
/cc-ui/v1/labels/{labelId}
Get label by ID
getLabelById 1 param → 200400403404405409500
PUT
/cc-ui/v1/labels/{labelId}
Update a label
updateLabel 1 param body → 200400403404405409500
ui-maintenance-window-controller 3
PUT
/cc-ui/v1/maintenance-window
update_2 body → 200400403404405409500
GET
/cc-ui/v1/maintenance-window/{clusterId}
getByClusterId 1 param → 200400403404405409500
PUT
/cc-ui/v1/maintenance-window/{clusterId}/enable-disable
enableDisable 2 params → 200400403404405409500
Module Management 15
GET
/cc-ui/v1/modules
Get All Modules
getAllModules 1 param → 200400403404405409500
GET
/cc-ui/v1/modules/all
Get All Modules
getAll_2 3 params → 200400403404405409500
POST
/cc-ui/v1/modules/bootstrap
Bootstrap Modules
bootstrapModules → 200400403404405409500
POST
/cc-ui/v1/modules/intent/{intent}/flavor/{flavor}/version/{version}/mark-published
Mark Module as Published
markAsPublished 3 params → 200400403404405409500
GET
/cc-ui/v1/modules/modules-lite
getAllModulesLite 2 params → 200400403404405409500
GET
/cc-ui/v1/modules/stack/{stackName}/grouped
Get Grouped Modules for Stack
getGroupedModulesForStack 1 param → 200400403404405409500
GET
/cc-ui/v1/modules/stack/{stackName}/{intent}/{flavor}/{version}/module
getModuleForIFVAndStack 4 params → 200400403404405409500
POST
/cc-ui/v1/modules/upload
Upload a module
uploadModule body → 200400403404405409500
GET
/cc-ui/v1/modules/version/{versionId}/download
downloadModuleByVersionId 1 param → 200400403404405409500
DELETE
/cc-ui/v1/modules/{id}
Delete a Module
deleteTfModule 2 params → 200400403404405409500
GET
/cc-ui/v1/modules/{id}
Get Module by ID
getById 1 param → 200400403404405409500
GET
/cc-ui/v1/modules/{id}/download
downloadModuleById 1 param → 200400403404405409500
POST
/cc-ui/v1/modules/{id}/mark-published
Mark Module as Published
markAsPublishedById 1 param → 200400403404405409500
GET
/cc-ui/v1/modules/{id}/usages
Get Module Usages
getModuleUsages 1 param → 200400403404405409500
GET
/cc-ui/v1/modules/{stackName}/intent/{intent}/flavor/{flavor}/add-ons
Get Add-On Modules
getIntentAddOnModules 4 params → 200400403404405409500
Modules Repo 9
DELETE
/cc-ui/v1/modules-repo
Unregister the modules repo
unregister → 200400403404405409500
GET
/cc-ui/v1/modules-repo
Get the org's modules repo
get → 200400403404405409500
PATCH
/cc-ui/v1/modules-repo
Update the modules repo
patch body → 200400403404405409500
POST
/cc-ui/v1/modules-repo
Register an existing modules repo
register body → 200400403404405409500
POST
/cc-ui/v1/modules-repo/bootstrap
Bootstrap the modules repo
bootstrap body → 200400403404405409500
GET
/cc-ui/v1/modules-repo/bootstrap/{jobId}
Get bootstrap job status
getBootstrapJob 1 param → 200400403404405409500
POST
/cc-ui/v1/modules-repo/rotate-ci-token
Rotate the CI service-account token
rotateCiToken → 200400403404405409500
POST
/cc-ui/v1/modules-repo/sync
Sync the modules repo with the registry
sync → 200400403404405409500
GET
/cc-ui/v1/modules-repo/sync/{jobId}
Get sync job status
getSyncJob 1 param → 200400403404405409500
ui-notification-controller 17
GET
/cc-ui/v1/notification/channelTypes
getAllChannelTypes → 200400403404405409500
GET
/cc-ui/v1/notification/channels
getAllChannels → 200400403404405409500
POST
/cc-ui/v1/notification/channels
createNotificationChannel body → 200400403404405409500
POST
/cc-ui/v1/notification/channels/test
testNotificationChannel body → 200400403404405409500
DELETE
/cc-ui/v1/notification/channels/{channelId}
deleteNotificationChannel 1 param → 200400403404405409500
GET
/cc-ui/v1/notification/channels/{channelId}
getChannel 1 param → 200400403404405409500
PUT
/cc-ui/v1/notification/channels/{channelId}
editNotificationChannel 1 param body → 200400403404405409500
GET
/cc-ui/v1/notification/notificationTags
getAllNotificationTags → 200400403404405409500
GET
/cc-ui/v1/notification/notificationType/{notificationType}/attributes
getSubscriptionAttributes 1 param → 200400403404405409500
GET
/cc-ui/v1/notification/notificationTypes
getAllNotificationTypes → 200400403404405409500
GET
/cc-ui/v1/notification/subscriptions
getAllSubscriptions_1 → 200400403404405409500
POST
/cc-ui/v1/notification/subscriptions
createSubscription_1 body → 200400403404405409500
DELETE
/cc-ui/v1/notification/subscriptions/{subscriptionId}
deleteSubscription 1 param → 200400403404405409500
GET
/cc-ui/v1/notification/subscriptions/{subscriptionId}
getSubscription 1 param → 200400403404405409500
PUT
/cc-ui/v1/notification/subscriptions/{subscriptionId}
editSubscription 1 param body → 200400403404405409500
POST
/cc-ui/v1/notification/{notificationType}/tag/{tagName}/values/
getFiltersForSubscriptions 2 params body → 200400403404405409500
GET
/cc-ui/v1/notification/{notificationType}/tags
getNotificationTagsForNotificationType 1 param → 200400403404405409500
ui-o-auth-controller 6
GET
/cc-ui/v1/oauth
getAllIntegrations_1 → 200400403404405409500
POST
/cc-ui/v1/oauth
addIntegrations_1 body → 200400403404405409500
POST
/cc-ui/v1/oauth/generic-oauth-integration
addGenericOAuthIntegration body → 200400403404405409500
PUT
/cc-ui/v1/oauth/generic-oauth-integration
editGenericOAuthIntegration 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/oauth/{registrationId}
deleteIntegrations_1 1 param → 200400403404405409500
PUT
/cc-ui/v1/oauth/{registrationId}
updateIntegrations_1 1 param body → 200400403404405409500
ui-one-time-webhook-controller 2
GET
/cc-ui/v1/onetime-webhook/poll/{webhookId}
pollWebhook 1 param → 200400403404405409500
POST
/cc-ui/v1/onetime-webhook/registerdeprecated
registerWebhook body → 200400403404405409500
ui-opa-controller 8
GET
/cc-ui/v1/opa
getAllPolicies → 200400403404405409500
POST
/cc-ui/v1/opa/enable-disable-policies
bulkEditOpaPolicyState body → 200400403404405409500
GET
/cc-ui/v1/opa/policy-templates
getAllPolicyTemplates → 200400403404405409500
DELETE
/cc-ui/v1/opa/{policyName}
deletePolicy 1 param → 200400403404405409500
GET
/cc-ui/v1/opa/{policyName}
getPolicy 1 param → 200400403404405409500
POST
/cc-ui/v1/opa/{policyName}
createPolicy 1 param body → 200400403404405409500
PUT
/cc-ui/v1/opa/{policyName}
editPolicy 1 param body → 200400403404405409500
POST
/cc-ui/v1/opa/{policyName}/execute
executePolicy 1 param body → 200400403404405409500
ui-project-type-controller 5
GET
/cc-ui/v1/project-types
Get all project types
getAllProjectTypes 1 param → 200400403404405409500
POST
/cc-ui/v1/project-types
Add a new project type
addProjectType body → 200400403404405409500
DELETE
/cc-ui/v1/project-types/{id}
Delete a project type
deleteProjectType 1 param → 200400403404405409500
GET
/cc-ui/v1/project-types/{id}
Get project type by ID
getProjectTypeById 1 param → 200400403404405409500
PUT
/cc-ui/v1/project-types/{id}
Update an existing project type
updateProjectType 1 param body → 200400403404405409500
ui-release-stream-controller 3
GET
/cc-ui/v1/release-stream
getAll_1 1 param → 200400403404405409500
POST
/cc-ui/v1/release-stream
add_1 body → 200400403404405409500
DELETE
/cc-ui/v1/release-stream/{name}
delete_2 1 param → 200400403404405409500
ui-resource-group-controller 10
GET
/cc-ui/v1/resource-groups
findAll → 200400403404405409500
POST
/cc-ui/v1/resource-groups
create body → 200400403404405409500
GET
/cc-ui/v1/resource-groups/me
getResourceGroupsForSessionUser → 200400403404405409500
POST
/cc-ui/v1/resource-groups/update-resource-groups-for-resource
updateResourceGroupsForResource body → 200400403404405409500
DELETE
/cc-ui/v1/resource-groups/{resourceGroupId}
delete_1 1 param → 200400403404405409500
GET
/cc-ui/v1/resource-groups/{resourceGroupId}
getResourceGroup 1 param → 200400403404405409500
PUT
/cc-ui/v1/resource-groups/{resourceGroupId}
update_1 1 param body → 200400403404405409500
PATCH
/cc-ui/v1/resource-groups/{resourceGroupId}/resources
updateResource 1 param body → 200400403404405409500
PUT
/cc-ui/v1/resource-groups/{resourceGroupId}/resources
updateAllResources 1 param body → 200400403404405409500
GET
/cc-ui/v1/resource-groups/{stackName}/{resourceType}/{resourceName}
getResourceGroupsForResource 3 params → 200400403404405409500
ui-resource-status-controller 4
POST
/cc-ui/v1/resources/sync
syncResource body → 200400403404405409500
GET
/cc-ui/v1/resources/{baseClusterId}/base-env-in-use-namespaces
getNamespacesInUseByDependentClusters 1 param → 200400403404405409500
GET
/cc-ui/v1/resources/{clusterId}/release-preview
getReleasePreview 1 param → 200400403404405409500
GET
/cc-ui/v1/resources/{projectName}/{environmentName}/status
getResourceStatus 3 params → 200400403404405409500
ui-saml-controller 4
GET
/cc-ui/v1/saml
getAllIntegrations → 200400403404405409500
POST
/cc-ui/v1/saml
addIntegrations body → 200400403404405409500
DELETE
/cc-ui/v1/saml/{registrationId}
deleteIntegrations 1 param → 200400403404405409500
PUT
/cc-ui/v1/saml/{registrationId}
updateIntegrations 1 param body → 200400403404405409500
Service Accounts 4
GET
/cc-ui/v1/service-accounts
List the shipped service accounts
list → 200400403404405409500
GET
/cc-ui/v1/service-accounts/{accountId}/tokens
List a service account's tokens
listTokens 1 param → 200400403404405409500
POST
/cc-ui/v1/service-accounts/{accountId}/tokens
Mint a service account token
mintToken 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/service-accounts/{accountId}/tokens/{tokenId}
Revoke a service account token
revokeToken 2 params → 200400403404405409500
ui-settings-controller 5
GET
/cc-ui/v1/settings/entity/{entity}
getAllSettingsForEntity 1 param → 200400403404405409500
PUT
/cc-ui/v1/settings/onboarding-display/{value}
setOnboardingDisplay 1 param → 200400403404405409500
GET
/cc-ui/v1/settings/ui-yaml
getAllSettingsYaml → 200400403404405409500
GET
/cc-ui/v1/settings/value/{entityType}/{entityId}
getSettingValue 2 params → 200400403404405409500
PUT
/cc-ui/v1/settings/value/{entityType}/{entityId}
addSettingValue 2 params body → 200400403404405409500
ui-stack-controller 39
GET
/cc-ui/v1/stacks/
getStacks → 200400403404405409500
POST
/cc-ui/v1/stacks/
createStack body → 200400403404405409500
GET
/cc-ui/v1/stacks/clusters
getAllClusters 3 params → 200400403404405409500
GET
/cc-ui/v1/stacks/migrate-overrides
migrateOverridesToGit 1 param → 200400403404405409500
POST
/cc-ui/v1/stacks/migrate-overrides-v2
migrateOverridesToGitV2 body → 200400403404405409500
POST
/cc-ui/v1/stacks/project
createProject body → 200400403404405409500
GET
/cc-ui/v1/stacks/projects-with-running-environments
Get projects with running environments
getProjectsWithRunningEnvironments → 200400403404405409500
GET
/cc-ui/v1/stacks/running-base-clusters
getRunningBaseClusters → 200400403404405409500
GET
/cc-ui/v1/stacks/running-clusters-with-kubedebugger
getRunningClustersWithKubedebugger → 200400403404405409500
POST
/cc-ui/v1/stacks/substack/{substackName}
createSubStack 1 param body → 200400403404405409500
GET
/cc-ui/v1/stacks/templates
getStackTemplates → 200400403404405409500
POST
/cc-ui/v1/stacks/v2
createStackV2 body → 200400403404405409500
DELETE
/cc-ui/v1/stacks/{stackName}
deleteStack 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}
getStack 1 param → 200400403404405409500
PUT
/cc-ui/v1/stacks/{stackName}
updateStack 1 param body → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/clusters
getClusters 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/clusters-metadata
getClusterMetadataByStack 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/clusters-overview
getClustersOverview 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/clustersWithStatusdeprecated
getClustersWithStatus 1 param → 200400403404405409500
PUT
/cc-ui/v1/stacks/{stackName}/enable-git-ops
enableGitOps 1 param body → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/localDeploymentContext
getLocalDeploymentContext 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/notification/subscriptions
getAllSubscriptions 1 param → 200400403404405409500
POST
/cc-ui/v1/stacks/{stackName}/notification/subscriptions
createSubscription 1 param body → 200400403404405409500
DELETE
/cc-ui/v1/stacks/{stackName}/overrides-fields
deleteOverridesFields 1 param body → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/project-overview
Get project overview
getProjectOverview 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/reload
reloadStack 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/resourceType/{resourceType}/resourceName/{resourceName}/overrides
getOverrides 3 params → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/suggestions/resourceTypedeprecated
getResourceTypes 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/suggestions/resourceType/{resourceType}deprecated
getResourcesByTypes 2 params → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/sync-resources
syncResources 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/sync-with-gitdeprecated
syncStackWithGit 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/sync-with-git/v2
Sync stack with git
stackSyncWithGit 1 param → 200400403404405409500
POST
/cc-ui/v1/stacks/{stackName}/template
saveAsTemplate 1 param body → 200400403404405409500
POST
/cc-ui/v1/stacks/{stackName}/template-v2
saveAsTemplateV2 1 param body → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/templateInputs/meta
getAllTemplateInputsMeta 1 param → 200400403404405409500
POST
/cc-ui/v1/stacks/{stackName}/toggleRelease
toggleRelease 1 param body → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/withAccount
getStackWithAccount 1 param → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/{resourceType}/deprecated
getApplicationList 2 params → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/{resourceType}/{appName}
getApplication 3 params → 200400403404405409500
Variable Management 4

APIs for managing individual variables and secrets

POST
/cc-ui/v1/stacks/{stackName}/variables
Add new variable/secret
addVariable 1 param body → 200400403404405409500
PUT
/cc-ui/v1/stacks/{stackName}/variables
Update variable/secret
updateVariable 1 param body → 200400403404405409500
POST
/cc-ui/v1/stacks/{stackName}/variables/bulk
Add multiple new variables/secrets
addVariablesBulk 1 param body → 200400403404405409500
GET
/cc-ui/v1/stacks/{stackName}/variables/{variableName}/environments
Get variable/secret across environments
getVariableAcrossEnvironments 2 params → 200400403404405409500
ui-tf-version-controller 8
DELETE
/cc-ui/v1/terraform/cluster/{clusterId}
deleteTfStreamForCluster 1 param → 200400403404405409500
GET
/cc-ui/v1/terraform/cluster/{clusterId}
getTfStreamForCluster 1 param → 200400403404405409500
PUT
/cc-ui/v1/terraform/cluster/{clusterId}
setTfVersionForCluster 1 param body → 200400403404405409500
GET
/cc-ui/v1/terraform/cluster/{clusterId}/pending-migration-scripts
getPendingMigrationScriptsByClusterId 1 param → 200400403404405409500
GET
/cc-ui/v1/terraform/stream/versions
getTfVersionsByStream 1 param → 200400403404405409500
GET
/cc-ui/v1/terraform/stream/{tfStream}/versionsdeprecated
getTfVersionsForStream 1 param → 200400403404405409500
POST
/cc-ui/v1/terraform/sync-release-stream-mapping
populateReleaseStreamTfVersionMapping → 200400403404405409500
GET
/cc-ui/v1/terraform/versions
getAllVersions → 200400403404405409500
TF Output Management 5
GET
/cc-ui/v1/tf-outputs
getAllOutputs → 200400403404405409500
POST
/cc-ui/v1/tf-outputs
createOrUpdateOutput body → 200400403404405409500
GET
/cc-ui/v1/tf-outputs/provider
Get all outputs that use a specific provider source
getOutputsByProviderSource 1 param → 200400403404405409500
DELETE
/cc-ui/v1/tf-outputs/{name}
Delete a TF output by name and namespace
deleteOutput 3 params → 200400403404405409500
GET
/cc-ui/v1/tf-outputs/{name}
getOutputByName 2 params → 200400403404405409500
ui-theme-file-controller 1
POST
/cc-ui/v1/themeFile
saveThemeFile body → 200400403404405409500
ui-user-group-controller 7
GET
/cc-ui/v1/user-groups/
getAllGroup → 200400403404405409500
POST
/cc-ui/v1/user-groups/
createUserGroup body → 200400403404405409500
PUT
/cc-ui/v1/user-groups/
updateUserGroup body → 200400403404405409500
GET
/cc-ui/v1/user-groups/list/groups-expanded
getAllUserGroupsExpanded → 200400403404405409500
DELETE
/cc-ui/v1/user-groups/{groupId}
deleteUserGroup 1 param → 200400403404405409500
GET
/cc-ui/v1/user-groups/{groupId}
getUserGroup 1 param → 200400403404405409500
GET
/cc-ui/v1/user-groups/{groupId}/group-expanded
getUserGroupExpanded 1 param → 200400403404405409500
ui-user-vcs-token-controller 4
GET
/cc-ui/v1/user-token
getAll → 200400403404405409500
POST
/cc-ui/v1/user-token
add body → 200400403404405409500
PUT
/cc-ui/v1/user-token
update body → 200400403404405409500
DELETE
/cc-ui/v1/user-token/{id}
delete 1 param → 200400403404405409500
ui-user-controller 13
GET
/cc-ui/v1/users/
getAllUsers → 200400403404405409500
GET
/cc-ui/v1/users/analyze-access
analyzeAccess 1 param → 200400403404405409500
POST
/cc-ui/v1/users/createAccessToken
createToken 1 param → 200400403404405409500
GET
/cc-ui/v1/users/current-user
getCurrentUser → 200400403404405409500
POST
/cc-ui/v1/users/invite-users
inviteUsers body → 200400403404405409500
GET
/cc-ui/v1/users/list/users-expanded
getAllUsersExpanded → 200400403404405409500
GET
/cc-ui/v1/users/roles
getAllSystemRoles → 200400403404405409500
GET
/cc-ui/v1/users/tokens
getToken → 200400403404405409500
DELETE
/cc-ui/v1/users/tokens/{tokenId}
deleteToken 1 param → 200400403404405409500
POST
/cc-ui/v1/users/updatePassword
updatePassword body → 200400403404405409500
DELETE
/cc-ui/v1/users/{userId}
deleteUser 1 param → 200400403404405409500
GET
/cc-ui/v1/users/{userId}
getUser 1 param → 200400403404405409500
GET
/cc-ui/v1/users/{userId}/user-expanded
getUserExpanded 1 param → 200400403404405409500
ui-versioning-controller 9
GET
/cc-ui/v1/versions/id/{id}
getVersionById 1 param → 200400403404405409500
DELETE
/cc-ui/v1/versions/softDeletedEntities
deleteSoftDeleteEntity 1 param → 200400403404405409500
GET
/cc-ui/v1/versions/softDeletedEntities
softDeletedEntities 3 params → 200400403404405409500
DELETE
/cc-ui/v1/versions/softDeletedEntities/all
deleteAllSoftDeleteEntities → 200400403404405409500
POST
/cc-ui/v1/versions/softDeletedEntities/{entityId}
restoreSoftDelete 1 param → 200400403404405409500
GET
/cc-ui/v1/versions/softDeletedEntities/{entityType}
softDeletedEntitiesByType 4 params → 200400403404405409500
POST
/cc-ui/v1/versions/{versionId}/restore
restore 1 param → 200400403404405409500
GET
/cc-ui/v1/versions/{versioningKey}
getVersions 3 params → 200400403404405409500
GET
/cc-ui/v1/versions/{versioningKey}/paginated
getVersionsPaginated 3 params → 200400403404405409500
ui-web-component-controller 6
GET
/cc-ui/v1/web-components
getAllComponents 3 params → 200400403404405409500
POST
/cc-ui/v1/web-components
createComponent body → 200400403404405409500
GET
/cc-ui/v1/web-components/assets/**
serveAsset → 200400403404405409500
DELETE
/cc-ui/v1/web-components/{webComponentId}
deleteComponent 1 param → 200400403404405409500
GET
/cc-ui/v1/web-components/{webComponentId}
getComponent 1 param → 200400403404405409500
PUT
/cc-ui/v1/web-components/{webComponentId}
updateComponent 1 param body → 200400403404405409500
ui-promotion-workflow-controller 8
GET
/cc-ui/v1/workflow
getAllWorkflows → 200400403404405409500
POST
/cc-ui/v1/workflow
createWorkflow body → 200400403404405409500
GET
/cc-ui/v1/workflow/blueprint/{stackName}
getWorkflowsByStack 1 param → 200400403404405409500
GET
/cc-ui/v1/workflow/default-workflow/registration-type/{registrationType}
getDefaultWorkflow 2 params → 200400403404405409500
GET
/cc-ui/v1/workflow/registration-specific
getRegistrationSpecificWorkflows 2 params → 200400403404405409500
DELETE
/cc-ui/v1/workflow/{workflowId}
deleteWorkflow 1 param → 200400403404405409500
GET
/cc-ui/v1/workflow/{workflowId}
getWorkflow 1 param → 200400403404405409500
PUT
/cc-ui/v1/workflow/{workflowId}
updateWorkflow 1 param body → 200400403404405409500
ui-no-auth-user-controller 3
POST
/public-ui/v1/user/resetPassword
resetPasswordRequest body → 200400403404405409500
POST
/public-ui/v1/user/savePassword
savePassword body → 200400403404405409500
POST
/public-ui/v1/user/token/validate
validateToken body → 200400403404405409500
public-ap-is 20
GET
/public/v1/cp-cloud
getCPCloud → 200400403404405409500
GET
/public/v1/features
getAllFeatureProperties → 200400403404405409500
GET
/public/v1/features/{name}
getFeatureProperty 1 param → 200400403404405409500
POST
/public/v1/github-installation-request
processGithubInstallationRequest body → 200400403404405409500
GET
/public/v1/health
healthCheck → 200400403404405409500
POST
/public/v1/link-aws
linkAwsAccount body → 200400403404405409500
POST
/public/v1/link-azure
linkAzureAccount body → 200400403404405409500
POST
/public/v1/link-bitbucket
linkBitbucketAccount body → 200400403404405409500
POST
/public/v1/link-docker-registries
linkDockerRegistries body → 200400403404405409500
POST
/public/v1/link-ecr
linkECR body → 200400403404405409500
POST
/public/v1/link-gcp
linkGcpAccount body → 200400403404405409500
POST
/public/v1/link-github
linkGithubAccount body → 200400403404405409500
POST
/public/v1/link-gitlab
linkGitlabAccount body → 200400403404405409500
POST
/public/v1/link-kubernetes
linkK8sAccount body → 200400403404405409500
GET
/public/v1/loginOptions
getLoginOptions → 200400403404405409500
GET
/public/v1/logo
getLogo → 200400403404405409500
GET
/public/v1/module/{intent}/{flavor}/{version}/schema
getModuleSchema 4 params → 200400403404405409500
GET
/public/v1/module/{intent}/{flavor}/{version}/schema/{type}
getModuleSchemaByType 5 params → 200400403404405409500
GET
/public/v1/samlLoginOptions
getSamlLoginOptions → 200400403404405409500
GET
/public/v1/themeFile
retrieveThemeFile → 200400403404405409500

Schemas 582

The contract defines 582 schemas that model the data the API accepts and returns. The most detailed are AzureCluster (46 properties), AwsCluster (45 properties), GCPCluster (44 properties), Substack (42 properties). Each schema is shown below with its type and property counts.

AWSElasticBlockStoreVolumeSource
object
4 properties
AbstractCluster
object
36 properties 4 required
AccessAnalyzerResponse
object
3 properties
AccessRoleDetails
object
7 properties
Account
object
15 properties
AccountAssociationInfo
object
3 properties
AccountLinkingDetails
object
2 properties
ActionDto
object
Represents an action definition
8 properties 1 required
ActionParameterDto
object
Defines a parameter that can be passed to an action
5 properties 2 required
ActionParameterValueDto
object
Represents the value of an action parameter
3 properties 1 required
ActionRunDto
object
Represents an action run instance with its execution details
15 properties 3 required
ActionRunRequestDto
object
Request for running a single action with parameters
2 properties 1 required
ActionStepDto
object
Represents a single step within an action run
8 properties 2 required
AddOnDTO
object
5 properties
AddResourceToGroupsRequest
object
4 properties 4 required
AddVariablesRequest
object
Request to add variables to the blueprint
3 properties 1 required
AffectedResource
object
2 properties
AffectedResourcesRequest
object
1 property 1 required
Affinity
object
3 properties
AllRegionsAndAZ
object
2 properties
AppArmorProfile
object
2 properties
AppDeployment
object
2 properties
ApplyTemplateRequest
object
Request to apply a template to a blueprint
4 properties
Artifact
object
26 properties
ArtifactByEnvironmentRequest
object
7 properties 4 required
ArtifactByReleaseStreamRequest
object
7 properties 3 required
ArtifactCI
object
10 properties 2 required
ArtifactRequest
object
16 properties 2 required
ArtifactRoutingRuleRequest
object
7 properties 4 required
ArtifactRoutingRuleResponse
object
8 properties
Artifactory
object
13 properties 1 required
ArtifactoryLinkingRequest
object
2 properties
ArtifactoryMirror
object
4 properties
ArtifactoryOneTimeWebhook
object
12 properties
AttachDetachCiRequest
object
Request details for attaching or detaching a rule and workflow to/from a CI.
3 properties 3 required
AttachLabelsRequest
object
Request to attach labels to a deployment log
1 property 1 required
AuditEntityActionOption
object
3 properties
AuditEnumOption
object
2 properties
AutocompleteResponseV2
object
1 property
AvailabilitySchedule
object
8 properties 1 required
AvailabilityTaskSchedule
object
8 properties 1 required
AwsAccount
object
19 properties
AwsCluster
object
45 properties 4 required
AwsClusterRequest
object
23 properties 1 required
AzureAccount
object
21 properties
AzureCluster
object
46 properties 4 required
AzureClusterRequest
object
26 properties 1 required
AzureDiskVolumeSource
object
6 properties
AzureFileVolumeSource
object
3 properties
BasicDockerArtifactory
object
16 properties 2 required
BasicDockerDTO
object
8 properties 4 required
BillingMetadata
object
3 properties
BitBucketAccount
object
22 properties
BitbucketOauthAppPayload
object
2 properties
BlueprintFile
object
25 properties
BlueprintFileContent
object
4 properties
BlueprintFileSummaryDto
object
3 properties
BlueprintPullRequest
object
18 properties
BlueprintValidationError
object
5 properties
BootstrapJobResponse
object
5 properties
BootstrapModulesRepoRequest
object
6 properties
BootstrapStep
object
3 properties
BootstrapTriggerResponse
object
1 property
BranchDTO
object
2 properties
BranchUpdateRequest
object
1 property
BulkActionRunRequestDto
object
Request for running multiple actions with individual parameters
1 property 1 required
BulkInheritFromBaseRequest
object
Request to bulk set inherit-from-base for resources in the blueprint
3 properties 1 required
BulkReleaseChangesRequest
object
1 property 1 required
BulkToggleResourcesRequest
object
Request to bulk enable/disable resources in the blueprint
3 properties 1 required
BulkWorkflowAttachRequest
object
2 properties
CSIVolumeSource
object
5 properties
Capabilities
object
2 properties
CephFSVolumeSource
object
6 properties
Change
object
2 properties
ChangeRepresentationObject
object
4 properties
ChangedAttribute
object
3 properties
ChannelTypePayload
object
2 properties
CiArtifactResponse
object
19 properties
CiCdDto
object
Details required for configuring CI/CD for a project.
8 properties 4 required
CiCustomCiCdRequest
object
Request for configuring custom CI/CD for a specific CI integration.
5 properties 4 required
CiCustomCiCdResponse
object
Response containing CI-level CI/CD configuration details.
9 properties
CiNameUsageDto
object
4 properties
CinderVolumeSource
object
4 properties
ClientAuthenticationMethod
object
1 property
CloudLinkingRequest
object
4 properties
ClusterCostDTO
object
4 properties
ClusterInfo
object
2 properties
ClusterLite
object
3 properties
ClusterMetadata
object
6 properties
ClusterOverrideResponse
object
3 properties
ClusterOverview
object
6 properties
ClusterResourceBinding
object
3 properties
ClusterResourcesResponse
object
3 properties
ClusterResourcesResponse.FacetsResource
object
2 properties
ClusterResponse
object
30 properties
ClusterSchedule
object
15 properties 2 required
ClusterTfVersionMapping
object
7 properties 2 required
ClusterTrustBundleProjection
object
5 properties
CoderAccount
object
20 properties
CoderLaunchEligibilityResponse
object
2 properties
CoderWorkspaceResponse
object
3 properties
Commit
object
1 property
CommitLog
object
5 properties
Config
object
2 properties
ConfigMapDTO
object
3 properties
ConfigMapEnvSource
object
2 properties
ConfigMapKeySelector
object
3 properties
ConfigMapProjection
object
3 properties
ConfigMapVolumeSource
object
4 properties
Container
object
25 properties
ContainerDTO
object
4 properties
ContainerExtendedResourceRequest
object
3 properties
ContainerPort
object
5 properties
ContainerResizePolicy
object
2 properties
ContainerResourceMetricSource
object
3 properties
ContainerResourceMetricStatus
object
3 properties
ContainerRestartRule
object
2 properties
ContainerRestartRuleOnExitCodes
object
2 properties
ContainerState
object
3 properties
ContainerStateRunning
object
1 property
ContainerStateTerminated
object
7 properties
ContainerStateWaiting
object
2 properties
ContainerStatus
object
15 properties
ContainerUser
object
1 property
ContentFile
object
10 properties
ControlPlaneUISettings
object
Control Plane UI specific settings
2 properties
CopyConfigurationsRequest
object
Request containing source cluster ID, selection mode (INCLUDE/EXCLUDE), and set of configuration types
3 properties
CostDTO
object
3 properties
CrdDeploymentDetails
object
3 properties
CreateBlueprintRequest
object
18 properties
CreateProjectRequest
object
11 properties
CreatePullRequestRequest
object
Request to create a blueprint pull request (branch)
4 properties 1 required
CreateResourceItem
object
6 properties 2 required
CreateResourcesRequest
object
Request to create resources in the blueprint
3 properties 1 required
CreateServiceAccountTokenRequest
object
2 properties
CreateTemplateRequest
object
5 properties
CreateWorkspaceExistingBranchRequest
object
2 properties 2 required
CreateWorkspaceNewBranchRequest
object
3 properties 3 required
Criterion
object
5 properties 4 required
CronJobDTO
object
6 properties
CrossVersionObjectReference
object
3 properties
CustomOAuth2ClientRegistration
object
10 properties 6 required
CustomRoleRequest
object
7 properties 1 required
CustomSamlRegistration
object
9 properties 4 required
CustomerOnboardRequest
object
7 properties 5 required
DaemonSetDTO
object
8 properties
DailyCloudCostDTO
object
7 properties
DailyCost
object
4 properties
DeleteResourcesRequest
object
Request to delete resources from the blueprint
3 properties 1 required
DeleteVariablesRequest
object
Request to delete variables from the blueprint
3 properties 1 required
DeletedEntitySoftDelete
object
7 properties
DeploymentContext
object
20 properties
DeploymentDTO
object
5 properties
DeploymentLog
object
40 properties
DeploymentOverview
object
13 properties
DeploymentRequest
object
20 properties 1 required
DeploymentStatsDto
object
2 properties
DeploymentStatusCountDto
object
3 properties
DeploymentsStats
object
4 properties
DomainDTO
object
4 properties 2 required
DownwardAPIProjection
object
1 property
DownwardAPIVolumeFile
object
4 properties
DownwardAPIVolumeSource
object
2 properties
DraftClusterRequest
object
16 properties 1 required
ECRArtifactory
object
21 properties 5 required
ECRAuthorizationData
object
2 properties
Edge
object
7 properties
EmptyDirVolumeSource
object
2 properties
EnableDisableOPAPolicy
object
2 properties
EnableGitOpsRequest
object
4 properties
EnvFromSource
object
3 properties
EnvInfo
object
3 properties
EnvSpecificAccess
object
4 properties
EnvVar
object
3 properties
EnvVarSource
object
5 properties
Environment
object
36 properties 4 required
EnvironmentRequest
object
16 properties 1 required
EnvironmentVariableValue
object
Variable/secret value in a specific environment
4 properties
EphemeralContainer
object
26 properties
EphemeralVolumeSource
object
1 property
ErrorDetails
object
2 properties
Event
object
17 properties
EventDTO
object
5 properties
EventSeries
object
2 properties
EventSource
object
2 properties
ExclusionFilter
object
2 properties
ExecAction
object
1 property
ExecutionTime
object
2 properties
ExpandedUser
object
13 properties
ExpandedUserGroup
object
8 properties
ExternalMetricSource
object
2 properties
ExternalMetricStatus
object
2 properties
FCVolumeSource
object
5 properties
FacetsAuditLogResponse
object
13 properties
FacetsResource
object
2 properties
FieldsV1
object
FileKeySelector
object
4 properties
FlexVolumeSource
object
5 properties
FlockerVolumeSource
object
2 properties
GCEPersistentDiskVolumeSource
object
4 properties
GCPCluster
object
44 properties 4 required
GCPClusterRequest
object
24 properties 1 required
GRPCAction
object
2 properties
GcpAccount
object
19 properties
GenericOAuth2ClientRegistration
object
15 properties 10 required
GitHubAccount
object
22 properties
GitLabAccount
object
22 properties
GitRepoVolumeSource
object
3 properties
GithubAppInstallationPayload
object
4 properties
GithubAppInstallationRequest
object
3 properties
GithubAppInstallationRequestResponse
object
1 property
GithubAppPermissionStatus
object
5 properties
GithubAppPermissionsPendingErrorDetails
object
5 properties
GithubLabel
object
3 properties
GithubUser
object
2 properties
GitlabOauthAppPayload
object
3 properties
GlusterfsVolumeSource
object
3 properties
GrantedAuthority
object
1 property
GroupedCountDto
object
2 properties
HPAScalingPolicy
object
3 properties
HPAScalingRules
object
4 properties
HTTPGetAction
object
5 properties
HTTPHeader
object
2 properties
HTTPIngressPath
object
3 properties
HTTPIngressRuleValue
object
1 property
HistoryMetadata
object
3 properties
HookRequest
object
Install or replace a blueprint hook script
4 properties 2 required
HookResponse
object
Blueprint hook state
5 properties
HorizontalPodAutoscaler
object
5 properties
HorizontalPodAutoscalerBehavior
object
2 properties
HorizontalPodAutoscalerCondition
object
5 properties
HorizontalPodAutoscalerDTO
object
4 properties
HorizontalPodAutoscalerSpec
object
5 properties
HorizontalPodAutoscalerStatus
object
6 properties
HostAlias
object
2 properties
HostIP
object
1 property
HostPathVolumeSource
object
2 properties
HotfixDeploymentRecipe
object
1 property
ISCSIVolumeSource
object
11 properties
IdName
object
2 properties
ImageOverrideRequest
object
12 properties 2 required
ImageVolumeSource
object
2 properties
ImageVolumeStatus
object
1 property
Info
object
21 properties
Ingress
object
5 properties
IngressBackend
object
2 properties
IngressBackendDTO
object
2 properties
IngressDTO
object
5 properties
IngressLoadBalancerIngress
object
3 properties
IngressLoadBalancerStatus
object
1 property
IngressPortStatus
object
3 properties
IngressRule
object
2 properties
IngressRulesDTO
object
3 properties
IngressServiceBackend
object
2 properties
IngressSpec
object
4 properties
IngressStatus
object
1 property
IngressTLS
object
2 properties
InheritFromBaseItem
object
3 properties 2 required
Input
object
Input parameters for this module
8 properties
InputOutputResource
object
4 properties
IntOrString
object
3 properties
IntentOutput
object
5 properties
IntentRequestDTO
object
6 properties 3 required
IntentResponseDTO
object
7 properties
InviteUserRequest
object
3 properties
JobDTO
object
4 properties
JsonNode
object
KeyToPath
object
3 properties
KubernetesAccount
object
20 properties
KubernetesCluster
object
39 properties 4 required
KubernetesClusterRequest
object
16 properties 1 required
KubernetesCredential
object
3 properties
Label
object
8 properties
LabelRequest
object
Label request with label name and optional color code
3 properties 1 required
LabelSelector
object
2 properties
LabelSelectorRequirement
object
3 properties
Lifecycle
object
3 properties
LifecycleHandler
object
4 properties
LinuxContainerUser
object
3 properties
ListDeploymentsWrapper
object
9 properties
ListPullRequestResponse
object
5 properties
ListResourcesResponse
object
Response entity containing grouped resources and templates
2 properties
ListWorkflowRunsResponse
object
5 properties
LocalObjectReference
object
1 property
LogEvent
object
2 properties
MaintenanceWindowDTO
object
13 properties 5 required
ManagedFieldsEntry
object
7 properties
MatchedModuleDTO
object
2 properties
MatchedResourceDTO
object
3 properties
Metric
object
2 properties
MetricIdentifier
object
2 properties
MetricSpec
object
6 properties
MetricStatus
object
6 properties
MetricTarget
object
4 properties
MetricValueStatus
object
3 properties
MicroTime
object
1 property
MigrateOverridesRequest
object
3 properties
MigrationScriptMetadata
object
4 properties
ModuleDTO
object
2 properties
ModuleInputDTO
object
5 properties
ModuleMetadata
object
5 properties
ModuleSchemaResponseDTO
object
Response containing complete JSON schema for module configuration
5 properties
ModuleUsageDTO
object
5 properties
ModulesRepo
object
13 properties
NFSVolumeSource
object
3 properties
NodeAffinity
object
2 properties
NodeAllocatableResourceClaimStatus
object
3 properties
NodeSelector
object
1 property
NodeSelectorRequirement
object
3 properties
NodeSelectorTerm
object
2 properties
NotificationChannel
object
8 properties
NotificationTagPayload
object
2 properties
NotificationTagsForTypeResult
object
3 properties
NotificationTypeResponse
object
4 properties
ObjectFieldSelector
object
2 properties
ObjectMeta
object
15 properties
ObjectMetricSource
object
3 properties
ObjectMetricStatus
object
3 properties
ObjectReference
object
7 properties
OneTimePayloadAwsAccount
object
2 properties
OneTimePayloadAzureAccount
object
2 properties
OneTimePayloadBasicDockerDTO
object
2 properties
OneTimePayloadBitbucketOauthAppPayload
object
2 properties
OneTimePayloadECRArtifactory
object
2 properties
OneTimePayloadGcpAccount
object
2 properties
OneTimePayloadGithubAppInstallationPayload
object
2 properties
OneTimePayloadGitlabOauthAppPayload
object
2 properties
OneTimePayloadKubernetesAccount
object
2 properties
OneTimeWebhook
object
11 properties
OpaPolicy
object
18 properties
OpaPolicyExecutionResult
object
3 properties
OpaPolicyRequest
object
14 properties
OtherVersion
object
2 properties
OutputIntentUsageDTO
object
3 properties
OutputModuleUsageDTO
object
6 properties
OutputReference
object
5 properties
OverrideConfig
object
7 properties
OverrideDelete
object
2 properties
OverrideDeleteRequest
object
4 properties
OverrideObject
object
11 properties
OverrideRequest
object
5 properties 2 required
OwnerReference
object
6 properties
Package
object
18 properties
PackageResponse
object
1 property
PageAbstractCluster
object
11 properties
PageDeploymentLog
object
11 properties
PageFacetsAuditLogResponse
object
11 properties
PageResourceReleaseImpact
object
11 properties
PageVersionVersioned
object
11 properties
PageableObject
object
6 properties
PasswordChange
object
2 properties
PatchModulesRepoRequest
object
3 properties
PauseReleaseRequest
object
2 properties
PendingMigrationDetails
object
3 properties
PersistentVolumeClaimDTO
object
8 properties
PersistentVolumeClaimSpec
object
9 properties
PersistentVolumeClaimTemplate
object
2 properties
PersistentVolumeClaimVolumeSource
object
2 properties
PersistentVolumeDTO
object
9 properties
PhotonPersistentDiskVolumeSource
object
2 properties
PipelineNode
object
6 properties
Pod
object
5 properties
PodAffinity
object
2 properties
PodAffinityTerm
object
6 properties
PodAntiAffinity
object
2 properties
PodCertificateProjection
object
7 properties
PodCondition
object
7 properties
PodDNSConfig
object
3 properties
PodDNSConfigOption
object
2 properties
PodDTO
object
6 properties
PodExtendedResourceClaimStatus
object
2 properties
PodIP
object
1 property
PodOS
object
1 property
PodReadinessGate
object
1 property
PodResourceClaim
object
3 properties
PodResourceClaimStatus
object
2 properties
PodSchedulingGate
object
1 property
PodSchedulingGroup
object
1 property
PodSecurityContext
object
13 properties
PodSpec
object
42 properties
PodStatus
object
21 properties
PodStatusDTO
object
4 properties
PodsMetricSource
object
2 properties
PodsMetricStatus
object
2 properties
PolicyTemplateDTO
object
6 properties
PortInfo
object
1 property
PortworxVolumeSource
object
3 properties
PreferredSchedulingTerm
object
2 properties
Probe
object
10 properties
ProjectType
object
19 properties
ProjectTypeFilter
object
2 properties
ProjectTypeMappedResource
object
Allowed modules for the project
3 properties 3 required
ProjectTypeRequest
object
Request model for Project Type operations.
15 properties 3 required
ProjectTypeResponse
object
20 properties
ProjectWithRunningEnvironmentsResponse
object
2 properties
ProjectedVolumeSource
object
2 properties
PromotionWorkflow
object
10 properties 2 required
ProvidedAuthenticatedResource
object
6 properties
ProvidedCloudResource
object
4 properties
ProvidedResources
object
6 properties
ProvidedShardedService
object
1 property
ProvidedUnauthenticatedResource
object
4 properties
PullRequestResponse
object
8 properties
PushCredentialsRequest
object
Request details for generating push credentials for an artifact.
3 properties 3 required
PushCredentialsResponse
object
4 properties
Quantity
object
2 properties
QueuedRelease
object
18 properties
QuobyteVolumeSource
object
6 properties
RBDVolumeSource
object
8 properties
RawError
object
4 properties
RefExpression
object
1 property
RegionAndZone
object
2 properties
RegisterModulesRepoRequest
object
5 properties
ReleaseButtonStatus
object
2 properties
ReleaseChanges
object
3 properties
ReleaseDetails
object
5 properties
ReleasePreviewResponse
object
4 properties
ReleaseStream
object
6 properties
ReleaseStreamRequest
object
3 properties 1 required
ReleaseStreamResponse
object
7 properties
RenameResourceRequest
object
Request to rename a resource
5 properties 3 required
ReplicaStatus
object
4 properties
ReplicasetDTO
object
6 properties
Repository
object
10 properties
ResetPasswordRequest
object
1 property
ResourceAffectedResponse
object
4 properties
ResourceChange
object
5 properties
ResourceClaim
object
2 properties
ResourceConnectionStringResponse
object
Connection string information for a resource interface
7 properties
ResourceDetails
object
5 properties
ResourceEnableDisableRequest
object
5 properties
ResourceFieldSelector
object
3 properties
ResourceFileRequest
object
9 properties 2 required
ResourceGroup
object
8 properties
ResourceGroupRequest
object
2 properties 1 required
ResourceHistory
object
11 properties
ResourceHistoryOverview
object
11 properties
ResourceIdentifier
object
2 properties 2 required
ResourceInfo
object
2 properties 1 required
ResourceInheritFromBaseRequest
object
5 properties
ResourceList
object
2 properties
ResourceMetadata
object
7 properties
ResourceMetricSource
object
2 properties
ResourceMetricStatus
object
2 properties
ResourceOutProperties
object
7 properties
ResourceReleaseImpact
object
7 properties
ResourceRenameRequest
object
5 properties 3 required
ResourceRequirements
object
3 properties
ResourceStatus
object
27 properties
ResourceStatusMetadata
object
3 properties
ResourceStatusResponse
object
4 properties
ResourceSyncRequest
object
3 properties
ResourceToggleItem
object
Optional list of resources to enable/disable as a side-effect of this update. All changes are committed atomically in a single commit.
3 properties 2 required
Response
object
2 properties
RoleInfo
object
2 properties
RoleMapping
object
14 properties
RotateCiTokenResponse
object
3 properties
SELinuxOptions
object
4 properties
SaasArtifactRequest
object
Request details for registering a SaaS artifact.
10 properties 5 required
SaveAsTemplateRequest
object
10 properties 2 required
SavePasswordResetPasswordRequest
object
3 properties
ScaleIOVolumeSource
object
10 properties
ScheduleRequest
object
9 properties
SeccompProfile
object
2 properties
SecretDTO
object
5 properties
SecretEnvSource
object
2 properties
SecretKeySelector
object
3 properties
SecretProjection
object
3 properties
SecretStatus
object
2 properties
SecretVolumeSource
object
4 properties
SecretsContextDTO
object
7 properties
SecurityContext
object
12 properties
SecurityReportSummary
object
5 properties
Selectors
object
4 properties
ServiceAccountResponse
object
7 properties
ServiceAccountTokenProjection
object
3 properties
ServiceAccountTokenResponse
object
4 properties
ServiceAccountTokenView
object
6 properties
ServiceBackendPort
object
2 properties
ServiceCost
object
4 properties
ServiceCostDTO
object
3 properties
ServiceDTO
object
7 properties
ServiceOverview
object
1 property
ServicePortDTO
object
4 properties
Setting
object
14 properties 5 required
ShortLivedTaskSchedule
object
3 properties 2 required
SilenceAlarmRequest
object
4 properties 3 required
SimpleOauth2User
object
12 properties
SleepAction
object
1 property
SnapshotInfo
object
10 properties
SoftDelete
object
1 property
SortObject
object
3 properties
Stack
object
41 properties
StackGitLog
object
10 properties
StackOverviewResponse
object
3 properties
StackResource
object
2 properties
StackResourceLite
object
8 properties
StackTemplate
object
6 properties
StackTemplateInput
object
4 properties 4 required
StatefulSetDTO
object
7 properties
StepLogDto
object
Contains logs for a specific step in a Tekton task run
2 properties 1 required
StorageOSVolumeSource
object
5 properties
StreamingResponseBody
object
Subscription
object
12 properties 1 required
Substack
object
42 properties
SubstackRequest
object
6 properties
SyncJobResponse
object
11 properties
SyncTriggerResponse
object
1 property
Sysctl
object
2 properties
TCPSocketAction
object
2 properties
TFModule
object
Model representing a Terraform Module
40 properties
TFModuleListResponseDTO
object
21 properties
TFModuleLiteDTO
object
Lightweight DTO for TF Modules providing minimal details
14 properties
TFModuleLiteListDTO
object
Grouped resources by type and name
4 properties
TFModulePath
object
Path information related to TF Module
3 properties
TFModuleResponseDTO
object
37 properties
TFOutputRequestDTO
object
5 properties 1 required
TFOutputResponseDTO
object
9 properties
TFOutputUsageDTO
object
5 properties
TFProvider
object
4 properties
TagDataModel
object
TargetResource
object
2 properties
TemplateGitDetails
object
Git details for the template used in Project Type
4 properties 4 required
TemplateResponseDTO
object
Templates associated with the resources
6 properties
TerraformChange
object
3 properties
TestNotificationRequest
object
7 properties
TestRuleResponse
object
1 property
TfVersion
object
4 properties 3 required
ThemeFileResponse
object
1 property
ToggleRelease
object
2 properties
TokenPaginatedResponseLogEvent
object
2 properties
TokenValidationRequest
object
1 property
TokenValidity
object
3 properties
Toleration
object
5 properties
ToolsConfig
object
4 properties
TopologySpreadConstraint
object
8 properties
TypedLocalObjectReference
object
3 properties
TypedObjectReference
object
4 properties
UpdateBlueprintRequest
object
2 properties
UpdateResourceItem
object
4 properties 2 required
UpdateResourcesRequest
object
Request to update resources in the blueprint
4 properties 1 required
UpdateVariablesRequest
object
Request to update variables in the blueprint
3 properties 1 required
User
object
11 properties
UserAccessToken
object
7 properties 1 required
UserGroup
object
12 properties
UserVCSTokenRequest
object
4 properties 3 required
UserVCSTokenResponse
object
4 properties
Utilization
object
2 properties
VCSAccountUpdateRequest
object
2 properties
VCSLinkingRequest
object
5 properties
VCSLinkingResponse
object
2 properties
VCSOrganizationsRequest
object
5 properties
VCSTokenDetailsResponse
object
5 properties
ValidationError
object
5 properties
ValidationResponse
object
5 properties
ValidationResult
object
2 properties
VariableCountDto
object
4 properties
VariableDetails
object
5 properties
VariableEnvironmentResponse
object
Variable/secret values across environments
6 properties
VariableItem
object
Map of variable name to updated variable details
4 properties
VariableRequest
object
Variable request with project default and environment values
6 properties 1 required
VariableUsageDTO
object
4 properties
VariableUsageResponse
object
4 properties
Variables
object
5 properties
Version
object
7 properties
VersionVersioned
object
7 properties
Versioned
object
2 properties
Volume
object
31 properties
VolumeDevice
object
2 properties
VolumeMount
object
7 properties
VolumeMountStatus
object
5 properties
VolumeProjection
object
6 properties
VolumeResourceRequirements
object
2 properties
VolumeStatus
object
1 property
VsphereVirtualDiskVolumeSource
object
4 properties
WebComponentDTO
object
Model representing a Web Component for embedding custom applications
20 properties 3 required
WebComponentScopeDetails
object
Which blueprint / environment a scoped web component applies to
5 properties
WeightedPodAffinityTerm
object
2 properties
WindowsSecurityContextOptions
object
4 properties
Workflow
object
2 properties
WorkflowHierarchy
object
2 properties
WorkflowRun
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

facets-control-plane-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Facets Control Plane API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.