{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Control Plane","description":"Documentation for Control Plane, a hybrid multi-cloud platform for deploying and managing workloads, Kubernetes, networking, secrets, logs, and infrastructure across AWS, GCP, Azure, and private clouds.","colors":{"primary":"#1563ff","light":"#64a5ef","dark":"#1563ff"},"logo":{"light":"https://mintcdn.com/controlplanecorporation/hwvJiAoqIziVJ3gK/logos/dark.svg?fit=max\u0026auto=format\u0026n=hwvJiAoqIziVJ3gK\u0026q=85\u0026s=ec7b5a4bb958adc4d92dedfb41ab2e3c","dark":"https://mintcdn.com/controlplanecorporation/hwvJiAoqIziVJ3gK/logos/light.svg?fit=max\u0026auto=format\u0026n=hwvJiAoqIziVJ3gK\u0026q=85\u0026s=4904ca0b5a8c55fa87495b8edd04aadc"},"favicon":"https://mintcdn.com/controlplanecorporation/hwvJiAoqIziVJ3gK/logos/favicon.png?fit=max\u0026auto=format\u0026n=hwvJiAoqIziVJ3gK\u0026q=85\u0026s=11640a5f7b1a462c233be7a72afa72d7","api":{"openapi":["https://api.cpln.io/openapi.json","https://audit.cpln.io/openapi.json"],"mdx":{"auth":{"method":"bearer"},"server":"https://api.cpln.io"}},"navbar":{"links":[{"href":"https://console.cpln.io/signin","label":"Sign in"}],"primary":{"type":"button","label":"Sign up","href":"https://console.cpln.io/signup"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/control-plane-corporation","youtube":"https://www.youtube.com/@controlplanecorporation","reddit":"https://www.reddit.com/r/controlplane"}},"search":{"prompt":"Search Control Plane docs..."},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity",{"title":"Install MCP Server","description":"Connect the Control Plane MCP Server to your AI tool","icon":"plug","href":"https://docs.controlplane.com/ai/overview"}],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"compass","href":"https://controlplane.com"},{"anchor":"Status","icon":"signal","href":"https://status.cpln.io/"},{"anchor":"Blog","icon":"newspaper","href":"https://controlplane.com/blog"},{"anchor":"FAQ","icon":"question","href":"https://controlplane.com/faq"},{"anchor":"Product Demos","icon":"video","href":"https://controlplane.com/product-demos"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"controlplanecorporation","hasAudioNarration":false,"actualSubdomain":"controlplanecorporation","customDomains":["docs.controlplane.com"],"gitSource":{"type":"github","owner":"controlplane-docs","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee7896259ab9305c629b84","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":173},{"language":"default","tag":"Core API","count":164},{"language":"default","tag":"Template Catalog","count":103},{"language":"default","tag":"Templates","count":93},{"language":"default","tag":"Home","count":79},{"language":"default","tag":"How-to Guides","count":72},{"language":"default","tag":"CLI Reference","count":66},{"language":"default","tag":"Reference","count":49},{"language":"default","tag":"Commands","count":38},{"language":"default","tag":"Workload","count":24}],"searchSettings":{"maxResults":5}},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":"html{overflow-y:scroll}"},{"filePath":"style.css","content":"img[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) saturate(100%) invert(69%) sepia(9%) saturate(309%) hue-rotate(176deg) brightness(95%) contrast(87%)!important}a[aria-current=\"page\"] img[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) saturate(100%) invert(28%) sepia(98%) saturate(3000%) hue-rotate(213deg) brightness(102%) contrast(101%)!important}.dark img[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) saturate(100%) invert(47%) sepia(8%) saturate(420%) hue-rotate(177deg) brightness(94%) contrast(85%)!important}.dark a[aria-current=\"page\"] img[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) saturate(100%) invert(63%) sepia(74%) saturate(380%) hue-rotate(186deg) brightness(98%) contrast(91%)!important}img.sidebar-group-icon[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0)!important}.dark img.sidebar-group-icon[src*=\"/icons/mcp-sidebar.svg\"]{filter:brightness(0) invert(1)!important}img[src*=\"/icons/mcp.svg\"]{filter:brightness(0) saturate(100%) invert(28%) sepia(98%) saturate(3000%) hue-rotate(213deg) brightness(102%) contrast(101%)!important}.dark img[src*=\"/icons/mcp.svg\"]{filter:brightness(0) saturate(100%) invert(63%) sepia(74%) saturate(380%) hue-rotate(186deg) brightness(98%) contrast(91%)!important}.dark img[src*=\"/icons/chatgpt.svg\"],.dark img[src*=\"/icons/codex.svg\"],.dark img[src*=\"/icons/cursor.svg\"],.dark img[src*=\"/icons/opencode.svg\"]{filter:invert(1)!important}"}],"page":{"pagePath":"api-reference/org/get-an-org-by-name","slug":"/api-reference/org/get-an-org-by-name","pageMetadata":{"openapi":"get /org/{name}","title":"Get an org by name","description":"Response will contain the requested org if the caller is authorized to view it","href":"/api-reference/org/get-an-org-by-name"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Response will contain the requested org if the caller is authorized to view it\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /org/{name}","title":"Get an org by name","description":"Response will contain the requested org if the caller is authorized to view it","href":"/api-reference/org/get-an-org-by-name"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/controlplanecorporation/20452e834d3719a6/content/legacy-cli-hash-redirects.js","/_mintlify/custom/controlplanecorporation/dd1961f62f732454/content/sync-tabs.js"],"openApiReferenceData":{"operation":{"tags":["org"],"summary":"Get an org by name","description":"Response will contain the requested org if the caller is authorized to view it","parameters":["16c4356e-f64a-4c7f-8496-d86aea3ad3ae"],"responses":{"200":"0299a4b9-04bd-44f6-af95-d859766a2cf4","403":"8688d0dc-e275-40a9-8cf8-82ea4449fda7"},"method":"get","type":"path","servers":["d56dccd7-a25a-45eb-aeaf-7cd270ecc515"],"security":["3418f629-1ff8-4ce7-b7bb-212b407b661c","73467719-7d3f-457a-ab94-eaed8e248135","c9d6a513-a7e0-496d-afaa-3533564d3b2e"],"path":"/org/{name}","baseUrlOptions":["https://api.cpln.io"],"title":"Get an org by name","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"16c4356e-f64a-4c7f-8496-d86aea3ad3ae":{"in":"path","name":"name","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"0299a4b9-04bd-44f6-af95-d859766a2cf4":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"uniqueKey":"id","typeLabel":"string"},"kind":{"type":"string","readOnly":true,"uniqueKey":"kind","typeLabel":"string"},"version":{"type":"integer","readOnly":true,"uniqueKey":"version","typeLabel":"integer"},"description":{"type":"string","maxLength":250,"uniqueKey":"description","typeLabel":"string"},"tags":{"type":"object","uniqueKey":"tags","typeLabel":"object"},"created":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"lastModified":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"lastModified","typeLabel":"string\u003cdate-time>"},"links":{"type":"array","items":{"type":"object","properties":{"rel":{"type":"string","uniqueKey":"links.items.[INDEX].rel","typeLabel":"string"},"href":{"type":"string","uniqueKey":"links.items.[INDEX].href","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"links.items.[INDEX]","typeLabel":"object"},"readOnly":true,"uniqueKey":"links","typeLabel":"object[]"},"name":{"type":"string","maxLength":64,"uniqueKey":"name","typeLabel":"string"},"spec":{"type":"object","properties":{"logging":{"type":"object","properties":{"s3":{"type":"object","properties":{"bucket":{"type":"string","uniqueKey":"spec.logging.s3.bucket","typeLabel":"string"},"region":{"type":"string","uniqueKey":"spec.logging.s3.region","typeLabel":"string"},"prefix":{"type":"string","default":"/","uniqueKey":"spec.logging.s3.prefix","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.logging.s3.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.s3","typeLabel":"object"},"coralogix":{"type":"object","properties":{"cluster":{"type":"string","enum":["coralogix.com","coralogix.us","app.coralogix.in","app.eu2.coralogix.com","app.coralogixsg.com"],"uniqueKey":"spec.logging.coralogix.cluster","typeLabel":"enum\u003cstring>"},"credentials":{"type":"string","uniqueKey":"spec.logging.coralogix.credentials","typeLabel":"string"},"app":{"type":"string","uniqueKey":"spec.logging.coralogix.app","typeLabel":"string"},"subsystem":{"type":"string","uniqueKey":"spec.logging.coralogix.subsystem","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.coralogix","typeLabel":"object"},"datadog":{"type":"object","properties":{"host":{"type":"string","enum":["http-intake.logs.datadoghq.com","http-intake.logs.us3.datadoghq.com","http-intake.logs.us5.datadoghq.com","http-intake.logs.datadoghq.eu"],"uniqueKey":"spec.logging.datadog.host","typeLabel":"enum\u003cstring>"},"credentials":{"type":"string","uniqueKey":"spec.logging.datadog.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.datadog","typeLabel":"object"},"logzio":{"type":"object","properties":{"listenerHost":{"type":"string","enum":["listener.logz.io","listener-nl.logz.io"],"uniqueKey":"spec.logging.logzio.listenerHost","typeLabel":"enum\u003cstring>"},"credentials":{"type":"string","uniqueKey":"spec.logging.logzio.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.logzio","typeLabel":"object"},"elastic":{"type":"object","properties":{"aws":{"type":"object","properties":{"host":{"type":"string","uniqueKey":"spec.logging.elastic.aws.host","typeLabel":"string"},"port":{"type":"integer","default":443,"uniqueKey":"spec.logging.elastic.aws.port","typeLabel":"integer"},"index":{"type":"string","uniqueKey":"spec.logging.elastic.aws.index","typeLabel":"string"},"type":{"type":"string","uniqueKey":"spec.logging.elastic.aws.type","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.logging.elastic.aws.credentials","typeLabel":"string"},"region":{"type":"string","uniqueKey":"spec.logging.elastic.aws.region","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.elastic.aws","typeLabel":"object"},"elasticCloud":{"type":"object","properties":{"index":{"type":"string","uniqueKey":"spec.logging.elastic.elasticCloud.index","typeLabel":"string"},"type":{"type":"string","uniqueKey":"spec.logging.elastic.elasticCloud.type","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.logging.elastic.elasticCloud.credentials","typeLabel":"string"},"cloudId":{"type":"string","uniqueKey":"spec.logging.elastic.elasticCloud.cloudId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.elastic.elasticCloud","typeLabel":"object"},"generic":{"type":"object","properties":{"host":{"type":"string","uniqueKey":"spec.logging.elastic.generic.host","typeLabel":"string"},"port":{"type":"integer","default":443,"uniqueKey":"spec.logging.elastic.generic.port","typeLabel":"integer"},"path":{"type":"string","uniqueKey":"spec.logging.elastic.generic.path","typeLabel":"string"},"index":{"type":"string","uniqueKey":"spec.logging.elastic.generic.index","typeLabel":"string"},"type":{"type":"string","uniqueKey":"spec.logging.elastic.generic.type","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.logging.elastic.generic.credentials","typeLabel":"string"},"username":{"type":"string","uniqueKey":"spec.logging.elastic.generic.username","typeLabel":"string"},"password":{"type":"string","uniqueKey":"spec.logging.elastic.generic.password","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.elastic.generic","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.logging.elastic","typeLabel":"object"},"cloudWatch":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ap-south-1","ap-northeast-2","ap-southeast-1","ap-southeast-2","ap-northeast-1","eu-central-1","eu-west-1","eu-west-2","eu-south-1","eu-west-3","eu-north-1","me-south-1","sa-east-1","af-south-1"],"uniqueKey":"spec.logging.cloudWatch.region","typeLabel":"enum\u003cstring>"},"credentials":{"type":"string","uniqueKey":"spec.logging.cloudWatch.credentials","typeLabel":"string"},"retentionDays":{"type":"integer","uniqueKey":"spec.logging.cloudWatch.retentionDays","typeLabel":"integer"},"groupName":{"type":"string","uniqueKey":"spec.logging.cloudWatch.groupName","typeLabel":"string"},"streamName":{"type":"string","uniqueKey":"spec.logging.cloudWatch.streamName","typeLabel":"string"},"extractFields":{"type":"object","uniqueKey":"spec.logging.cloudWatch.extractFields","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.logging.cloudWatch","typeLabel":"object"},"fluentd":{"type":"object","properties":{"host":{"type":"string","uniqueKey":"spec.logging.fluentd.host","typeLabel":"string"},"port":{"type":"integer","maximum":65535,"minimum":1,"default":24224,"uniqueKey":"spec.logging.fluentd.port","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"spec.logging.fluentd","typeLabel":"object"},"stackdriver":{"type":"object","properties":{"credentials":{"type":"string","uniqueKey":"spec.logging.stackdriver.credentials","typeLabel":"string"},"location":{"type":"string","enum":["us-east1","us-east4","us-central1","us-west1","europe-west4","europe-west1","europe-west3","europe-west2","asia-east1","asia-southeast1","asia-northeast1","asia-south1","australia-southeast1","southamerica-east1","africa-south1","asia-east2","asia-northeast2","asia-northeast3","asia-south2","asia-southeast2","australia-southeast2","europe-central2","europe-north1","europe-southwest1","europe-west10","europe-west12","europe-west6","europe-west8","europe-west9","me-central1","me-central2","me-west1","northamerica-northeast1","northamerica-northeast2","southamerica-west1","us-east5","us-south1","us-west2","us-west3","us-west4"],"uniqueKey":"spec.logging.stackdriver.location","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"spec.logging.stackdriver","typeLabel":"object"},"syslog":{"type":"object","properties":{"host":{"type":"string","uniqueKey":"spec.logging.syslog.host","typeLabel":"string"},"port":{"type":"integer","uniqueKey":"spec.logging.syslog.port","typeLabel":"integer"},"mode":{"type":"string","enum":["tcp","udp","tls"],"default":"tcp","uniqueKey":"spec.logging.syslog.mode","typeLabel":"enum\u003cstring>"},"format":{"type":"string","enum":["rfc3164","rfc5424"],"default":"rfc5424","uniqueKey":"spec.logging.syslog.format","typeLabel":"enum\u003cstring>"},"severity":{"type":"number","default":6,"description":"\n Emergency (EMERG) (severity level 0):\n System is unusable.\n\n Alert (ALERT) (severity level 1):\n Action must be taken immediately.\n\n Critical (CRIT) (severity level 2):\n Critical conditions.\n\n Error (ERR) (severity level 3):\n Error conditions.\n\n Warning (WARNING) (severity level 4):\n Warning conditions.\n\n Notice (NOTICE) (severity level 5):\n Normal but significant conditions.\n\n Informational (INFO) (severity level 6):\n Informational messages.\n\n Debug (DEBUG) (severity level 7):\n Debug-level messages.","uniqueKey":"spec.logging.syslog.severity","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"spec.logging.syslog","typeLabel":"object"},"opentelemetry":{"type":"object","properties":{"endpoint":{"type":"string","uniqueKey":"spec.logging.opentelemetry.endpoint","typeLabel":"string"},"headers":{"type":"object","uniqueKey":"spec.logging.opentelemetry.headers","typeLabel":"object"},"credentials":{"type":"string","uniqueKey":"spec.logging.opentelemetry.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.opentelemetry","typeLabel":"object"},"loki":{"type":"object","properties":{"endpoint":{"type":"string","uniqueKey":"spec.logging.loki.endpoint","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.logging.loki.credentials","typeLabel":"string"},"tenantId":{"type":"string","uniqueKey":"spec.logging.loki.tenantId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.logging.loki","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.logging","typeLabel":"object"},"extraLogging":{"type":"array","items":{"type":"object","properties":{"s3":{"type":"object","properties":{"bucket":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].s3.bucket","typeLabel":"string"},"region":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].s3.region","typeLabel":"string"},"prefix":{"type":"string","default":"/","uniqueKey":"spec.extraLogging.items.[INDEX].s3.prefix","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].s3.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].s3","typeLabel":"object"},"coralogix":{"type":"object","properties":{"cluster":{"type":"string","enum":["coralogix.com","coralogix.us","app.coralogix.in","app.eu2.coralogix.com","app.coralogixsg.com"],"uniqueKey":"spec.extraLogging.items.[INDEX].coralogix.cluster","typeLabel":"enum\u003cstring>"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].coralogix.credentials","typeLabel":"string"},"app":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].coralogix.app","typeLabel":"string"},"subsystem":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].coralogix.subsystem","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].coralogix","typeLabel":"object"},"datadog":{"type":"object","properties":{"host":{"type":"string","enum":["http-intake.logs.datadoghq.com","http-intake.logs.us3.datadoghq.com","http-intake.logs.us5.datadoghq.com","http-intake.logs.datadoghq.eu"],"uniqueKey":"spec.extraLogging.items.[INDEX].datadog.host","typeLabel":"enum\u003cstring>"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].datadog.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].datadog","typeLabel":"object"},"logzio":{"type":"object","properties":{"listenerHost":{"type":"string","enum":["listener.logz.io","listener-nl.logz.io"],"uniqueKey":"spec.extraLogging.items.[INDEX].logzio.listenerHost","typeLabel":"enum\u003cstring>"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].logzio.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].logzio","typeLabel":"object"},"elastic":{"type":"object","properties":{"aws":{"type":"object","properties":{"host":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.aws.host","typeLabel":"string"},"port":{"type":"integer","default":443,"uniqueKey":"spec.extraLogging.items.[INDEX].elastic.aws.port","typeLabel":"integer"},"index":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.aws.index","typeLabel":"string"},"type":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.aws.type","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.aws.credentials","typeLabel":"string"},"region":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.aws.region","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].elastic.aws","typeLabel":"object"},"elasticCloud":{"type":"object","properties":{"index":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.elasticCloud.index","typeLabel":"string"},"type":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.elasticCloud.type","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.elasticCloud.credentials","typeLabel":"string"},"cloudId":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.elasticCloud.cloudId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].elastic.elasticCloud","typeLabel":"object"},"generic":{"type":"object","properties":{"host":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic.host","typeLabel":"string"},"port":{"type":"integer","default":443,"uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic.port","typeLabel":"integer"},"path":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic.path","typeLabel":"string"},"index":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic.index","typeLabel":"string"},"type":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic.type","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic.credentials","typeLabel":"string"},"username":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic.username","typeLabel":"string"},"password":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic.password","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].elastic.generic","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].elastic","typeLabel":"object"},"cloudWatch":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ap-south-1","ap-northeast-2","ap-southeast-1","ap-southeast-2","ap-northeast-1","eu-central-1","eu-west-1","eu-west-2","eu-south-1","eu-west-3","eu-north-1","me-south-1","sa-east-1","af-south-1"],"uniqueKey":"spec.extraLogging.items.[INDEX].cloudWatch.region","typeLabel":"enum\u003cstring>"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].cloudWatch.credentials","typeLabel":"string"},"retentionDays":{"type":"integer","uniqueKey":"spec.extraLogging.items.[INDEX].cloudWatch.retentionDays","typeLabel":"integer"},"groupName":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].cloudWatch.groupName","typeLabel":"string"},"streamName":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].cloudWatch.streamName","typeLabel":"string"},"extractFields":{"type":"object","uniqueKey":"spec.extraLogging.items.[INDEX].cloudWatch.extractFields","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].cloudWatch","typeLabel":"object"},"fluentd":{"type":"object","properties":{"host":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].fluentd.host","typeLabel":"string"},"port":{"type":"integer","maximum":65535,"minimum":1,"default":24224,"uniqueKey":"spec.extraLogging.items.[INDEX].fluentd.port","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].fluentd","typeLabel":"object"},"stackdriver":{"type":"object","properties":{"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].stackdriver.credentials","typeLabel":"string"},"location":{"type":"string","enum":["us-east1","us-east4","us-central1","us-west1","europe-west4","europe-west1","europe-west3","europe-west2","asia-east1","asia-southeast1","asia-northeast1","asia-south1","australia-southeast1","southamerica-east1","africa-south1","asia-east2","asia-northeast2","asia-northeast3","asia-south2","asia-southeast2","australia-southeast2","europe-central2","europe-north1","europe-southwest1","europe-west10","europe-west12","europe-west6","europe-west8","europe-west9","me-central1","me-central2","me-west1","northamerica-northeast1","northamerica-northeast2","southamerica-west1","us-east5","us-south1","us-west2","us-west3","us-west4"],"uniqueKey":"spec.extraLogging.items.[INDEX].stackdriver.location","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].stackdriver","typeLabel":"object"},"syslog":{"type":"object","properties":{"host":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].syslog.host","typeLabel":"string"},"port":{"type":"integer","uniqueKey":"spec.extraLogging.items.[INDEX].syslog.port","typeLabel":"integer"},"mode":{"type":"string","enum":["tcp","udp","tls"],"default":"tcp","uniqueKey":"spec.extraLogging.items.[INDEX].syslog.mode","typeLabel":"enum\u003cstring>"},"format":{"type":"string","enum":["rfc3164","rfc5424"],"default":"rfc5424","uniqueKey":"spec.extraLogging.items.[INDEX].syslog.format","typeLabel":"enum\u003cstring>"},"severity":{"type":"number","default":6,"description":"\n Emergency (EMERG) (severity level 0):\n System is unusable.\n\n Alert (ALERT) (severity level 1):\n Action must be taken immediately.\n\n Critical (CRIT) (severity level 2):\n Critical conditions.\n\n Error (ERR) (severity level 3):\n Error conditions.\n\n Warning (WARNING) (severity level 4):\n Warning conditions.\n\n Notice (NOTICE) (severity level 5):\n Normal but significant conditions.\n\n Informational (INFO) (severity level 6):\n Informational messages.\n\n Debug (DEBUG) (severity level 7):\n Debug-level messages.","uniqueKey":"spec.extraLogging.items.[INDEX].syslog.severity","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].syslog","typeLabel":"object"},"opentelemetry":{"type":"object","properties":{"endpoint":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].opentelemetry.endpoint","typeLabel":"string"},"headers":{"type":"object","uniqueKey":"spec.extraLogging.items.[INDEX].opentelemetry.headers","typeLabel":"object"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].opentelemetry.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].opentelemetry","typeLabel":"object"},"loki":{"type":"object","properties":{"endpoint":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].loki.endpoint","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].loki.credentials","typeLabel":"string"},"tenantId":{"type":"string","uniqueKey":"spec.extraLogging.items.[INDEX].loki.tenantId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX].loki","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.extraLogging.items.[INDEX]","typeLabel":"object"},"uniqueKey":"spec.extraLogging","typeLabel":"object[]"},"tracing":{"type":"object","properties":{"sampling":{"type":"number","maximum":100,"minimum":0,"uniqueKey":"spec.tracing.sampling","typeLabel":"number"},"lightstep":{"type":"object","properties":{"endpoint":{"type":"string","uniqueKey":"spec.tracing.lightstep.endpoint","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.tracing.lightstep.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.tracing.lightstep","typeLabel":"object"},"customTags":{"type":"object","uniqueKey":"spec.tracing.customTags","typeLabel":"object"},"provider":{"type":"object","properties":{"otel":{"type":"object","properties":{"endpoint":{"type":"string","uniqueKey":"spec.tracing.provider.otel.endpoint","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.tracing.provider.otel","typeLabel":"object"},"lightstep":{"type":"object","properties":{"endpoint":{"type":"string","uniqueKey":"spec.tracing.provider.lightstep.endpoint","typeLabel":"string"},"credentials":{"type":"string","uniqueKey":"spec.tracing.provider.lightstep.credentials","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"spec.tracing.provider.lightstep","typeLabel":"object"},"controlplane":{"type":"object","properties":{},"additionalProperties":false,"uniqueKey":"spec.tracing.provider.controlplane","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.tracing.provider","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.tracing","typeLabel":"object"},"sessionTimeoutSeconds":{"type":"number","minimum":900,"uniqueKey":"spec.sessionTimeoutSeconds","typeLabel":"number"},"authConfig":{"type":"object","properties":{"domainAutoMembers":{"type":"array","items":{"type":"string","uniqueKey":"spec.authConfig.domainAutoMembers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"spec.authConfig.domainAutoMembers","typeLabel":"string[]"},"samlOnly":{"type":"boolean","uniqueKey":"spec.authConfig.samlOnly","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"spec.authConfig","typeLabel":"object"},"observability":{"type":"object","properties":{"logsRetentionDays":{"type":"integer","maximum":3650,"minimum":0,"default":30,"uniqueKey":"spec.observability.logsRetentionDays","typeLabel":"integer"},"metricsRetentionDays":{"type":"integer","maximum":3650,"minimum":0,"default":30,"uniqueKey":"spec.observability.metricsRetentionDays","typeLabel":"integer"},"tracesRetentionDays":{"type":"integer","maximum":3650,"minimum":0,"default":30,"uniqueKey":"spec.observability.tracesRetentionDays","typeLabel":"integer"},"defaultAlertEmails":{"type":"array","items":{"type":"string","uniqueKey":"spec.observability.defaultAlertEmails.items.[INDEX]","typeLabel":"string"},"description":"these emails are configured as alert recipients in grafana when the grafana-default-email contact delivery type is Email","uniqueKey":"spec.observability.defaultAlertEmails","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"spec.observability","typeLabel":"object"},"security":{"type":"object","properties":{"threatDetection":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether or not detected threats should be forwarded","uniqueKey":"spec.security.threatDetection.enabled","typeLabel":"boolean"},"minimumSeverity":{"type":"string","enum":["warning","error","critical"],"description":"any threats with this severity and more severe will be sent. Others will be ignored","uniqueKey":"spec.security.threatDetection.minimumSeverity","typeLabel":"enum\u003cstring>"},"syslog":{"type":"object","properties":{"transport":{"type":"string","enum":["tcp","udp"],"default":"tcp","description":"the transport-layer protocol to send the syslog messages over. If TCP is chosen, messages will be sent with TLS.","uniqueKey":"spec.security.threatDetection.syslog.transport","typeLabel":"enum\u003cstring>"},"host":{"type":"string","description":"the hostname to send syslog messages to","uniqueKey":"spec.security.threatDetection.syslog.host","typeLabel":"string"},"port":{"type":"integer","maximum":100000,"minimum":1,"description":"the port to send syslog messages to","uniqueKey":"spec.security.threatDetection.syslog.port","typeLabel":"integer"}},"additionalProperties":false,"description":"configuration for syslog forwarding","uniqueKey":"spec.security.threatDetection.syslog","typeLabel":"object"}},"additionalProperties":false,"description":"configure detected threats to be forwarded using a specified protocol","uniqueKey":"spec.security.threatDetection","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec.security","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"spec","typeLabel":"object"},"status":{"type":"object","properties":{"accountLink":{"type":"string","uniqueKey":"status.accountLink","typeLabel":"string"},"active":{"type":"boolean","uniqueKey":"status.active","typeLabel":"boolean"},"endpointPrefix":{"type":"string","uniqueKey":"status.endpointPrefix","typeLabel":"string"}},"additionalProperties":false,"readOnly":true,"uniqueKey":"status","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","kind":"\u003cstring>","version":123,"description":"\u003cstring>","tags":{},"created":"2023-11-07T05:31:56Z","lastModified":"2023-11-07T05:31:56Z","links":[{"rel":"\u003cstring>","href":"\u003cstring>"}],"name":"\u003cstring>","spec":{"logging":{"s3":{"bucket":"\u003cstring>","region":"\u003cstring>","prefix":"/","credentials":"\u003cstring>"},"coralogix":{"cluster":"coralogix.com","credentials":"\u003cstring>","app":"\u003cstring>","subsystem":"\u003cstring>"},"datadog":{"host":"http-intake.logs.datadoghq.com","credentials":"\u003cstring>"},"logzio":{"listenerHost":"listener.logz.io","credentials":"\u003cstring>"},"elastic":{"aws":{"host":"\u003cstring>","port":443,"index":"\u003cstring>","type":"\u003cstring>","credentials":"\u003cstring>","region":"\u003cstring>"},"elasticCloud":{"index":"\u003cstring>","type":"\u003cstring>","credentials":"\u003cstring>","cloudId":"\u003cstring>"},"generic":{"host":"\u003cstring>","port":443,"path":"\u003cstring>","index":"\u003cstring>","type":"\u003cstring>","credentials":"\u003cstring>","username":"\u003cstring>","password":"\u003cstring>"}},"cloudWatch":{"region":"us-east-1","credentials":"\u003cstring>","retentionDays":123,"groupName":"\u003cstring>","streamName":"\u003cstring>","extractFields":{}},"fluentd":{"host":"\u003cstring>","port":24224},"stackdriver":{"credentials":"\u003cstring>","location":"us-east1"},"syslog":{"host":"\u003cstring>","port":123,"mode":"tcp","format":"rfc5424","severity":6},"opentelemetry":{"endpoint":"\u003cstring>","headers":{},"credentials":"\u003cstring>"},"loki":{"endpoint":"\u003cstring>","credentials":"\u003cstring>","tenantId":"\u003cstring>"}},"extraLogging":[{"s3":{"bucket":"\u003cstring>","region":"\u003cstring>","prefix":"/","credentials":"\u003cstring>"},"coralogix":{"cluster":"coralogix.com","credentials":"\u003cstring>","app":"\u003cstring>","subsystem":"\u003cstring>"},"datadog":{"host":"http-intake.logs.datadoghq.com","credentials":"\u003cstring>"},"logzio":{"listenerHost":"listener.logz.io","credentials":"\u003cstring>"},"elastic":{"aws":{"host":"\u003cstring>","port":443,"index":"\u003cstring>","type":"\u003cstring>","credentials":"\u003cstring>","region":"\u003cstring>"},"elasticCloud":{"index":"\u003cstring>","type":"\u003cstring>","credentials":"\u003cstring>","cloudId":"\u003cstring>"},"generic":{"host":"\u003cstring>","port":443,"path":"\u003cstring>","index":"\u003cstring>","type":"\u003cstring>","credentials":"\u003cstring>","username":"\u003cstring>","password":"\u003cstring>"}},"cloudWatch":{"region":"us-east-1","credentials":"\u003cstring>","retentionDays":123,"groupName":"\u003cstring>","streamName":"\u003cstring>","extractFields":{}},"fluentd":{"host":"\u003cstring>","port":24224},"stackdriver":{"credentials":"\u003cstring>","location":"us-east1"},"syslog":{"host":"\u003cstring>","port":123,"mode":"tcp","format":"rfc5424","severity":6},"opentelemetry":{"endpoint":"\u003cstring>","headers":{},"credentials":"\u003cstring>"},"loki":{"endpoint":"\u003cstring>","credentials":"\u003cstring>","tenantId":"\u003cstring>"}}],"tracing":{"sampling":50,"lightstep":{"endpoint":"\u003cstring>","credentials":"\u003cstring>"},"customTags":{},"provider":{"otel":{"endpoint":"\u003cstring>"},"lightstep":{"endpoint":"\u003cstring>","credentials":"\u003cstring>"},"controlplane":{}}},"sessionTimeoutSeconds":901,"authConfig":{"domainAutoMembers":["\u003cstring>"],"samlOnly":true},"observability":{"logsRetentionDays":30,"metricsRetentionDays":30,"tracesRetentionDays":30,"defaultAlertEmails":["\u003cstring>"]},"security":{"threatDetection":{"enabled":true,"minimumSeverity":"warning","syslog":{"transport":"tcp","host":"\u003cstring>","port":50000}}}},"status":{"accountLink":"\u003cstring>","active":true,"endpointPrefix":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"8688d0dc-e275-40a9-8cf8-82ea4449fda7":{"description":"Not found or not allowed to view","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","uniqueKey":"details","typeLabel":"object"},"id":{"type":"string","uniqueKey":"id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":123,"message":"\u003cstring>","code":"\u003cstring>","details":{},"id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3418f629-1ff8-4ce7-b7bb-212b407b661c":{},"73467719-7d3f-457a-ab94-eaed8e248135":{"serviceAccountKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Service account key can be used as API keys","scopes":[],"schemeName":"serviceAccountKey"}},"c9d6a513-a7e0-496d-afaa-3533564d3b2e":{"jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"IDP-provided token","scopes":[],"schemeName":"jwt"}}},"servers":{"d56dccd7-a25a-45eb-aeaf-7cd270ecc515":{"url":"https://api.cpln.io","description":""}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Service account key can be used as API keys","scopes":[],"schemeName":"serviceAccountKey"},"schema":{"title":"Authorization","type":"string","description":"Service account key can be used as API keys","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"serviceAccountKey","name":"Authorization"}],"title":"serviceAccountKey"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"IDP-provided token","scopes":[],"schemeName":"jwt"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"IDP-provided token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"jwt","name":"Authorization"}],"title":"jwt"}]},"originalFileLocation":"https://api.cpln.io/openapi.json"},"subdomain":"controlplanecorporation","siteName":"Control Plane","title":"Get an org by name - Control Plane","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-02T16:48:40.941Z","originalFileLocation":"api-reference/org/get-an-org-by-name.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Response will contain the requested org if the caller is authorized to view it\">\u003cmeta data-mint-head name=\"application-name\" content=\"Control Plane\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an org by name - Control Plane\">\u003cmeta data-mint-head property=\"og:description\" content=\"Response will contain the requested org if the caller is authorized to view it\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Control Plane\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://controlplanecorporation.mintlify.site/_mintlify/api/og/v2?division=Org\u0026amp;title=Get+an+org+by+name\u0026amp;description=Response+will+contain+the+requested+org+if+the+caller+is+authorized+to+view+it\u0026amp;theme=5c8c59bec2193070854fc823\u0026amp;signature=97836b501460b60d9e8c54f2fbeee739848a04f0a94a66e08aadf6056b860c63\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get an org by name - Control Plane\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Response will contain the requested org if the caller is authorized to view it\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://controlplanecorporation.mintlify.site/_mintlify/api/og/v2?division=Org\u0026amp;title=Get+an+org+by+name\u0026amp;description=Response+will+contain+the+requested+org+if+the+caller+is+authorized+to+view+it\u0026amp;theme=5c8c59bec2193070854fc823\u0026amp;signature=97836b501460b60d9e8c54f2fbeee739848a04f0a94a66e08aadf6056b860c63\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/controlplanecorporation/N_jUg8p-q778yjKC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Control Plane\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1563ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/org/get-an-org-by-name.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.controlplane.com/#organization\",\"name\":\"Control Plane\",\"url\":\"https://docs.controlplane.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/controlplanecorporation/hwvJiAoqIziVJ3gK/logos/dark.svg?fit=max\u0026auto=format\u0026n=hwvJiAoqIziVJ3gK\u0026q=85\u0026s=ec7b5a4bb958adc4d92dedfb41ab2e3c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.controlplane.com#website\",\"name\":\"Control Plane\",\"url\":\"https://docs.controlplane.com\",\"publisher\":{\"@id\":\"https://docs.controlplane.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name#webpage\",\"url\":\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name\",\"name\":\"Get an org by name\",\"description\":\"Response will contain the requested org if the caller is authorized to view it\",\"dateModified\":\"2026-04-02T16:48:40.941Z\",\"isPartOf\":{\"@id\":\"https://docs.controlplane.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API\",\"item\":\"https://docs.controlplane.com/api-reference/agent/get-an-agent-by-name\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an org by name\",\"item\":\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name#apireference\",\"headline\":\"Get an org by name\",\"name\":\"Get an org by name\",\"description\":\"Response will contain the requested org if the caller is authorized to view it\",\"url\":\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name\",\"mainEntityOfPage\":{\"@id\":\"https://docs.controlplane.com/api-reference/org/get-an-org-by-name#webpage\"},\"dateModified\":\"2026-04-02T16:48:40.941Z\",\"publisher\":{\"@id\":\"https://docs.controlplane.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.controlplane.com#website\"}}]}\u003c/script>","siteName":"Control Plane","nav":{"global":{"anchors":[{"anchor":"Website","icon":"compass","href":"https://controlplane.com"},{"anchor":"Status","icon":"signal","href":"https://status.cpln.io/"},{"anchor":"Blog","icon":"newspaper","href":"https://controlplane.com/blog"},{"anchor":"FAQ","icon":"question","href":"https://controlplane.com/faq"},{"anchor":"Product Demos","icon":"video","href":"https://controlplane.com/product-demos"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/introduction"}]},{"tab":"How-to Guides","pages":[{"title":"How-to Guides","href":"/guides/overview"}]},{"tab":"Template Catalog","pages":[{"title":"Template Catalog","href":"/template-catalog/overview"}]},{"tab":"Managed Kubernetes","pages":[{"title":"Managed Kubernetes","href":"/mk8s/overview"}]},{"tab":"CPLN BYOK","pages":[{"title":"CPLN BYOK","href":"/byok/overview"}]},{"tab":"AI Agents","pages":[{"title":"AI Agents","href":"/ai/overview"}]},{"tab":"Infra as Code","pages":[{"title":"Infra as Code","href":"/iac/overview"}]},{"tab":"CLI Reference","pages":[{"title":"CLI Reference","href":"/cli-reference/overview"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Reference","sidebarTitle":"Introduction","href":"/api-reference/api"}]},{"group":"Core API","pages":[{"group":"Agent","pages":[{"openapi":"get /org/{org}/agent/{name}","title":"Get an agent by name","href":"/api-reference/agent/get-an-agent-by-name"},{"openapi":"delete /org/{org}/agent/{name}","title":"Delete an agent by name","href":"/api-reference/agent/delete-an-agent-by-name"},{"openapi":"patch /org/{org}/agent/{name}","title":"Perform a Patch on an agent by name","href":"/api-reference/agent/perform-a-patch-on-an-agent-by-name"},{"openapi":"get /org/{org}/agent/{name}/-info","title":"Query agent health","href":"/api-reference/agent/query-agent-health"},{"openapi":"get /org/{org}/agent","title":"Get all agents","href":"/api-reference/agent/get-all-agents"},{"openapi":"post /org/{org}/agent","title":"Create an agent","href":"/api-reference/agent/create-an-agent"},{"openapi":"post /org/{org}/agent/-query","title":"Get all agents based on a query","href":"/api-reference/agent/get-all-agents-based-on-a-query"},{"openapi":"get /org/{org}/agent/{name}/-accessreport","title":"Get the access report for an agent by name","href":"/api-reference/agent/get-the-access-report-for-an-agent-by-name"},{"openapi":"get /org/{org}/agent/-schema/permissions","title":"Get available permissions for an agent","href":"/api-reference/agent/get-available-permissions-for-an-agent"}]},{"group":"Audit Context","pages":[{"openapi":"get /org/{org}/auditctx/{name}","title":"Get an audit context by name","href":"/api-reference/auditctx/get-an-audit-context-by-name"},{"openapi":"delete /org/{org}/auditctx/{name}","title":"Delete an audit context by name","href":"/api-reference/auditctx/delete-an-audit-context-by-name"},{"openapi":"patch /org/{org}/auditctx/{name}","title":"Perform a Patch on an audit context by name","href":"/api-reference/auditctx/perform-a-patch-on-an-audit-context-by-name"},{"openapi":"get /org/{org}/auditctx","title":"Get all audit contexts","href":"/api-reference/auditctx/get-all-audit-contexts"},{"openapi":"post /org/{org}/auditctx","title":"Create an audit context","href":"/api-reference/auditctx/create-an-audit-context"},{"openapi":"post /org/{org}/auditctx/-query","title":"Get all audit contexts based on a query","href":"/api-reference/auditctx/get-all-audit-contexts-based-on-a-query"},{"openapi":"get /org/{org}/auditctx/{name}/-accessreport","title":"Get the access report for an audit context by name","href":"/api-reference/auditctx/get-the-access-report-for-an-audit-context-by-name"},{"openapi":"get /org/{org}/auditctx/-schema/permissions","title":"Get available permissions for an audit context","href":"/api-reference/auditctx/get-available-permissions-for-an-audit-context"}]},{"group":"Cloud Account","pages":[{"openapi":"get /org/{org}/cloudaccount/{name}","title":"Get a cloud account by name","href":"/api-reference/cloudaccount/get-a-cloud-account-by-name"},{"openapi":"delete /org/{org}/cloudaccount/{name}","title":"Delete an cloud account by name","href":"/api-reference/cloudaccount/delete-an-cloud-account-by-name"},{"openapi":"patch /org/{org}/cloudaccount/{name}","title":"Perform a Patch on a cloud account by name","href":"/api-reference/cloudaccount/perform-a-patch-on-a-cloud-account-by-name"},{"openapi":"get /org/{org}/cloudaccount","title":"Get all cloud accounts","href":"/api-reference/cloudaccount/get-all-cloud-accounts"},{"openapi":"post /org/{org}/cloudaccount","title":"Create a cloud account","href":"/api-reference/cloudaccount/create-a-cloud-account"},{"openapi":"post /org/{org}/cloudaccount/-query","title":"Get all cloud accounts based on a query","href":"/api-reference/cloudaccount/get-all-cloud-accounts-based-on-a-query"},{"openapi":"get /org/{org}/cloudaccount/{name}/-accessreport","title":"Get the access report for a cloud account by name","href":"/api-reference/cloudaccount/get-the-access-report-for-a-cloud-account-by-name"},{"openapi":"get /org/{org}/cloudaccount/-schema/permissions","title":"Get available permissions for a cloud account resource type","href":"/api-reference/cloudaccount/get-available-permissions-for-a-cloud-account-resource-type"}]},{"group":"Domain","pages":[{"openapi":"get /org/{org}/domain/{name}","title":"Get a domain by name","href":"/api-reference/domain/get-a-domain-by-name"},{"openapi":"delete /org/{org}/domain/{name}","title":"Delete a domain by name","href":"/api-reference/domain/delete-a-domain-by-name"},{"openapi":"patch /org/{org}/domain/{name}","title":"Perform a Patch on a domain by name","href":"/api-reference/domain/perform-a-patch-on-a-domain-by-name"},{"openapi":"get /org/{org}/domain","title":"Get all domains","href":"/api-reference/domain/get-all-domains"},{"openapi":"post /org/{org}/domain","title":"Create a domain","href":"/api-reference/domain/create-a-domain"},{"openapi":"post /org/{org}/domain/-query","title":"Get all domains based on a query","href":"/api-reference/domain/get-all-domains-based-on-a-query"},{"openapi":"get /org/{org}/domain/{name}/-accessreport","title":"Get the access report for a domain by name","href":"/api-reference/domain/get-the-access-report-for-a-domain-by-name"},{"openapi":"get /org/{org}/domain/-schema/permissions","title":"Get available permissions for a domain resource type","href":"/api-reference/domain/get-available-permissions-for-a-domain-resource-type"}]},{"group":"Group","pages":[{"openapi":"get /org/{org}/group/{name}","title":"Get a group by name","href":"/api-reference/group/get-a-group-by-name"},{"openapi":"delete /org/{org}/group/{name}","title":"Delete a group by name","href":"/api-reference/group/delete-a-group-by-name"},{"openapi":"patch /org/{org}/group/{name}","title":"Perform a Patch on a group by name","href":"/api-reference/group/perform-a-patch-on-a-group-by-name"},{"openapi":"get /org/{org}/group","title":"Get all groups","href":"/api-reference/group/get-all-groups"},{"openapi":"post /org/{org}/group","title":"Create a group","href":"/api-reference/group/create-a-group"},{"openapi":"post /org/{org}/group/-query","title":"Get all groups based on a query","href":"/api-reference/group/get-all-groups-based-on-a-query"},{"openapi":"get /org/{org}/group/{name}/-accessreport","title":"Get the access report for a group by name","href":"/api-reference/group/get-the-access-report-for-a-group-by-name"},{"openapi":"get /org/{org}/group/-schema/permissions","title":"Get available permissions for a group resource type","href":"/api-reference/group/get-available-permissions-for-a-group-resource-type"}]},{"group":"GVC","pages":[{"openapi":"get /org/{org}/gvc/{name}","title":"Get a GVC by name","href":"/api-reference/gvc/get-a-gvc-by-name"},{"openapi":"delete /org/{org}/gvc/{name}","title":"Delete a GVC by name","href":"/api-reference/gvc/delete-a-gvc-by-name"},{"openapi":"patch /org/{org}/gvc/{name}","title":"Perform a Patch on a GVC by name","href":"/api-reference/gvc/perform-a-patch-on-a-gvc-by-name"},{"openapi":"get /org/{org}/gvc","title":"Get all GVCs","href":"/api-reference/gvc/get-all-gvcs"},{"openapi":"post /org/{org}/gvc","title":"Create a GVC","href":"/api-reference/gvc/create-a-gvc"},{"openapi":"post /org/{org}/gvc/-query","title":"Get all GVCs based on a query","href":"/api-reference/gvc/get-all-gvcs-based-on-a-query"},{"openapi":"get /org/{org}/gvc/{name}/-accessreport","title":"Get the access report for a GVC by name","href":"/api-reference/gvc/get-the-access-report-for-a-gvc-by-name"},{"openapi":"get /org/{org}/gvc/-schema/permissions","title":"Get available permissions for a GVC resource type","href":"/api-reference/gvc/get-available-permissions-for-a-gvc-resource-type"}]},{"group":"Identity","pages":[{"openapi":"get /org/{org}/gvc/{gvc}/identity/{name}","title":"Get an identity by GVC and name","href":"/api-reference/identity/get-an-identity-by-gvc-and-name"},{"openapi":"delete /org/{org}/gvc/{gvc}/identity/{name}","title":"Delete an identity by GVC and name","href":"/api-reference/identity/delete-an-identity-by-gvc-and-name"},{"openapi":"patch /org/{org}/gvc/{gvc}/identity/{name}","title":"Perform a Patch on an identity by name","href":"/api-reference/identity/perform-a-patch-on-an-identity-by-name"},{"openapi":"get /org/{org}/gvc/{gvc}/identity","title":"Get all identities in a GVC","href":"/api-reference/identity/get-all-identities-in-a-gvc"},{"openapi":"post /org/{org}/gvc/{gvc}/identity","title":"Create an identity","href":"/api-reference/identity/create-an-identity"},{"openapi":"get /org/{org}/identity","title":"Get all identities from all GVCs","href":"/api-reference/identity/get-all-identities-from-all-gvcs"},{"openapi":"post /org/{org}/identity/-query","title":"Get all GVC identities based on a query","href":"/api-reference/identity/get-all-gvc-identities-based-on-a-query"},{"openapi":"get /org/{org}/gvc/{gvc}/identity/{name}/-accessreport","title":"Get the access report for an identity by GVC and name","href":"/api-reference/identity/get-the-access-report-for-an-identity-by-gvc-and-name"},{"openapi":"get /org/{org}/identity/-schema/permissions","title":"Get available permissions for an identity","href":"/api-reference/identity/get-available-permissions-for-an-identity"}]},{"group":"Image","pages":[{"openapi":"get /org/{org}/image/{name}","title":"Get a image by name","href":"/api-reference/image/get-an-image-by-name"},{"openapi":"delete /org/{org}/image/{name}","title":"Delete an image by name","href":"/api-reference/image/delete-an-image-by-name"},{"openapi":"patch /org/{org}/image/{name}","title":"Perform a Patch on an image by name","href":"/api-reference/image/perform-a-patch-on-an-image-by-name"},{"openapi":"get /org/{org}/image","title":"Get all images","href":"/api-reference/image/get-all-images"},{"openapi":"post /org/{org}/image/-query","title":"Get all images based on a query","href":"/api-reference/image/get-all-images-based-on-a-query"},{"openapi":"get /org/{org}/image/{name}/-accessreport","title":"Get the access report for an image by name","href":"/api-reference/image/get-the-access-report-for-an-image-by-name"},{"openapi":"get /org/{org}/image/-schema/permissions","title":"Get available permissions for an image resource type","href":"/api-reference/image/get-available-permissions-for-an-image-resource-type"}]},{"group":"IP Set","pages":[{"openapi":"get /org/{org}/ipset/{name}","title":"Get an IP Set by name","href":"/api-reference/ipset/get-an-ip-set-by-name"},{"openapi":"delete /org/{org}/ipset/{name}","title":"Delete an IP Set by name","href":"/api-reference/ipset/delete-an-ip-set-by-name"},{"openapi":"patch /org/{org}/secret/{name}","title":"Perform a Patch on a secret by name","href":"/api-reference/ipset/perform-a-patch-on-an-ip-set-by-name"},{"openapi":"get /org/{org}/ipset","title":"Get all IP Sets","href":"/api-reference/ipset/get-all-ip-sets"},{"openapi":"post /org/{org}/ipset","title":"Create an IP Set","href":"/api-reference/ipset/create-an-ip-set"},{"openapi":"get /org/{org}/ipset/{name}/-accessreport","title":"Get the access report for an IP Set by name","href":"/api-reference/ipset/get-the-access-report-for-an-ip-set-by-name"},{"openapi":"get /org/{org}/ipset/-schema/permissions","title":"Get available permissions for an IP Set resource type","href":"/api-reference/ipset/get-available-permissions-for-an-ip-set-resource-type"}]},{"group":"Location","pages":[{"openapi":"get /org/{org}/location/{name}","title":"Get a location by name","href":"/api-reference/location/get-a-location-by-name"},{"openapi":"patch /org/{org}/location/{name}","title":"Perform a Patch on a location by name","href":"/api-reference/location/perform-a-patch-on-a-location-by-name"},{"openapi":"get /org/{org}/location","title":"Get all locations","href":"/api-reference/location/get-all-locations"},{"openapi":"post /org/{org}/location/-query","title":"Get all locations based on a query","href":"/api-reference/location/get-all-locations-based-on-a-query"},{"openapi":"get /org/{org}/location/{name}/-accessreport","title":"Get the access report for a location by name","href":"/api-reference/location/get-the-access-report-for-a-location-by-name"},{"openapi":"get /org/{org}/location/-schema/permissions","title":"Get available permissions for a location resource type","href":"/api-reference/location/get-available-permissions-for-a-location-resource-type"}]},{"group":"Managed Kubernetes (mk8s)","pages":[{"openapi":"get /org/{org}/mk8s/{name}","title":"Get an mk8s cluster by name","href":"/api-reference/mk8s/get-an-mk8s-cluster-by-name"},{"openapi":"delete /org/{org}/mk8s/{name}","title":"Delete an mk8s cluster by name","href":"/api-reference/mk8s/delete-an-mk8s-cluster-by-name"},{"openapi":"patch /org/{org}/mk8s/{name}","title":"Perform a Patch on an mk8s cluster by name","href":"/api-reference/mk8s/perform-a-patch-on-an-mk8s-cluster-by-name"},{"openapi":"get /org/{org}/mk8s","title":"Get all mk8s clusters","href":"/api-reference/mk8s/get-all-mk8s-clusters"},{"openapi":"post /org/{org}/mk8s","title":"Create an Mk8s Cluster","href":"/api-reference/mk8s/create-an-mk8s-cluster"},{"openapi":"post /org/{org}/mk8s/-query","title":"Get all mk8s clusters based on a query","href":"/api-reference/mk8s/get-all-mk8s-clusters-based-on-a-query"},{"openapi":"get /org/{org}/mk8s/{name}/-cacerts","title":"CA root for this cluster","href":"/api-reference/mk8s/ca-root-for-this-cluster"},{"openapi":"get /org/{org}/mk8s/{name}/-ready","title":"Check if cluster is deployed","href":"/api-reference/mk8s/check-if-cluster-is-deployed"},{"openapi":"post /org/{org}/mk8s/{name}/-join","title":"Retrieve a join shell script.","href":"/api-reference/mk8s/retrieve-a-join-shell-script"},{"openapi":"post /org/{org}/mk8s/{name}/-cloudinit","title":"Retrieve a cloud-init script","href":"/api-reference/mk8s/retrieve-a-cloud-init-script"},{"openapi":"post /org/{org}/mk8s/{name}/-kubeconfig","title":"Retrieve a kubeconfig","href":"/api-reference/mk8s/retrieve-a-kubeconfig"},{"openapi":"get /org/{org}/mk8s/{name}/-accessreport","title":"Get the access report for an mk8s cluster name","href":"/api-reference/mk8s/get-the-access-report-for-an-mk8s-cluster-name"},{"openapi":"get /org/{org}/mk8s/-schema/permissions","title":"Get available permissions for an mk8s cluster resource type","description":"Response contains the grantable permissions that are available for an mk8s cluster when adding a binding in a policy.","href":"/api-reference/mk8s/get-available-permissions-for-an-mk8s-cluster-resource-type"}]},{"group":"Org","pages":[{"openapi":"get /org/{name}","title":"Get an org by name","href":"/api-reference/org/get-an-org-by-name"},{"openapi":"patch /org/{name}","title":"Perform a Patch on an org by name","description":"","href":"/api-reference/org/perform-a-patch-on-an-org-by-name"},{"openapi":"get /org","title":"Get all orgs","href":"/api-reference/org/get-all-orgs"},{"openapi":"post /org","title":null,"href":"/api-reference/org/create-an-org"},{"openapi":"post /org/-query","title":"Get all orgs based on a query","href":"/api-reference/org/get-all-orgs-based-on-a-query"},{"openapi":"get /org/{name}/-accessreport","title":"Get the access report for an org by name","href":"/api-reference/org/get-the-access-report-for-an-org-by-name"},{"openapi":"get /org/{org}/org/-schema/permissions","title":"Get available permissions for an org resource type","href":"/api-reference/org/get-available-permissions-for-an-org-resource-type"}]},{"group":"Policy","pages":[{"openapi":"get /org/{org}/policy/{name}","title":"Get a policy by name","href":"/api-reference/policy/get-a-policy-by-name"},{"openapi":"delete /org/{org}/policy/{name}","title":"Delete a policy by name","href":"/api-reference/policy/delete-a-policy-by-name"},{"openapi":"patch /org/{org}/policy/{name}","title":"Perform a Patch on a policy by name","href":"/api-reference/policy/perform-a-patch-on-a-policy-by-name"},{"openapi":"get /org/{org}/policy","title":"Get all policies","href":"/api-reference/policy/get-all-policies"},{"openapi":"post /org/{org}/policy","title":"Create a policy","href":"/api-reference/policy/create-a-policy"},{"openapi":"post /org/{org}/policy/-query","title":"Get all policies based on a query","href":"/api-reference/policy/get-all-policies-based-on-a-query"},{"openapi":"get /org/{org}/policy/{name}/-accessreport","title":"Get the access report for a policy by name","href":"/api-reference/policy/get-the-access-report-for-a-policy-by-name"},{"openapi":"get /org/{org}/policy/-schema/permissions","title":"Get available permissions for a policy resource type","href":"/api-reference/policy/get-available-permissions-for-a-policy-resource-type"}]},{"group":"Quota","pages":[{"openapi":"get /org/{org}/quota/{id}","title":"Get a quota by ID","href":"/api-reference/quota/get-a-quota-by-id"},{"openapi":"get /org/{org}/quota","title":"Get all quotas","href":"/api-reference/quota/get-all-quotas"},{"openapi":"post /org/{org}/quota/-query","title":"Get all quotas based on a query","href":"/api-reference/quota/get-all-quotas-based-on-a-query"},{"openapi":"get /org/{org}/quota/-schema/permissions","title":"Get available permissions for a quota resource type","href":"/api-reference/quota/get-available-permissions-for-a-quota-resource-type"}]},{"group":"Secret","pages":[{"openapi":"get /org/{org}/secret/{name}","title":"Get a secret by name","href":"/api-reference/secret/get-a-secret-by-name"},{"openapi":"delete /org/{org}/secret/{name}","title":"Delete a secret by name","href":"/api-reference/secret/delete-a-secret-by-name"},{"openapi":"patch /org/{org}/secret/{name}","title":"Perform a Patch on a secret by name","href":"/api-reference/secret/perform-a-patch-on-a-secret-by-name"},{"openapi":"get /org/{org}/secret","title":"Get all secrets","href":"/api-reference/secret/get-all-secrets"},{"openapi":"post /org/{org}/secret","title":"Create a secret","href":"/api-reference/secret/create-a-secret"},{"openapi":"get /org/{org}/secret/{name}/-reveal","title":"Get the sensitive content of a secret by name","href":"/api-reference/secret/get-the-sensitive-content-of-a-secret-by-name"},{"openapi":"post /org/{org}/secret/-query","title":"Get all secrets based on a query","href":"/api-reference/secret/get-all-secrets-based-on-a-query"},{"openapi":"get /org/{org}/secret/{name}/-accessreport","title":"Get the access report for a secret by name","href":"/api-reference/secret/get-the-access-report-for-a-secret-by-name"},{"openapi":"get /org/{org}/secret/-schema/permissions","title":"Get available permissions for a secret resource type","href":"/api-reference/secret/get-available-permissions-for-a-secret-resource-type"}]},{"group":"Service Account","pages":[{"openapi":"get /org/{org}/serviceaccount/{name}","title":"Get a service account by name","href":"/api-reference/serviceaccount/get-a-service-account-by-name"},{"openapi":"delete /org/{org}/serviceaccount/{name}","title":"Delete a service account by name","href":"/api-reference/serviceaccount/delete-a-service-account-by-name"},{"openapi":"patch /org/{org}/serviceaccount/{name}","title":"Perform a Patch on a service account by name","href":"/api-reference/serviceaccount/perform-a-patch-on-a-service-account-by-name"},{"openapi":"get /org/{org}/serviceaccount","title":"Get all service accounts","href":"/api-reference/serviceaccount/get-all-service-accounts"},{"openapi":"post /org/{org}/serviceaccount","title":"Create a service account","href":"/api-reference/serviceaccount/create-a-service-account"},{"openapi":"post /org/{org}/serviceaccount/-query","title":"Get all service accounts based on a query","href":"/api-reference/serviceaccount/get-all-service-accounts-based-on-a-query"},{"openapi":"get /org/{org}/serviceaccount/{name}/-accessreport","title":"Get the access report for a service account by name","href":"/api-reference/serviceaccount/get-the-access-report-for-a-service-account-by-name"},{"openapi":"post /org/{org}/serviceaccount/{name}/-addKey","title":"Add a key to a service account","href":"/api-reference/serviceaccount/add-a-key-to-a-service-account"},{"openapi":"get /org/{org}/serviceaccount/-schema/permissions","title":"Get available permissions for a service account resource type","href":"/api-reference/serviceaccount/get-available-permissions-for-a-service-account-resource-type"}]},{"group":"Task","pages":[{"openapi":"get /task/-forme","title":"List tasks that you can accept to refuse","href":"/api-reference/task/list-tasks-that-you-can-accept-to-refuse"},{"openapi":"get /org/{org}/task/-forme","title":"List tasks that you can accept to refuse in a specific org","href":"/api-reference/task/list-tasks-that-you-can-accept-to-refuse-in-a-specific-org"},{"openapi":"get /org/{org}/task/{id}","title":"Get a task by ID","href":"/api-reference/task/get-a-task-by-id"},{"openapi":"post /org/{org}/task/{id}","title":"Post","href":"/api-reference/task/post"},{"openapi":"delete /org/{org}/task/{id}","title":"Delete/Cancel a task by ID","href":"/api-reference/task/deletecancel-a-task-by-id"},{"openapi":"get /org/{org}/task","title":"Get all tasks","href":"/api-reference/task/get-all-tasks"},{"openapi":"post /org/{org}/task/-query","title":"Get all tasks based on a query","href":"/api-reference/task/get-all-tasks-based-on-a-query"},{"openapi":"get /org/{org}/task/-schema/permissions","title":"Get available permissions for a task resource type","href":"/api-reference/task/get-available-permissions-for-a-task-resource-type"}]},{"group":"User","pages":[{"openapi":"get /org/{org}/user/{name}","title":"Get a user by name","href":"/api-reference/user/get-a-user-by-name"},{"openapi":"delete /org/{org}/user/{name}","title":"Delete a user by name","href":"/api-reference/user/delete-a-user-by-name"},{"openapi":"patch /org/{org}/user/{name}","title":"Perform a Patch on a user by name","href":"/api-reference/user/perform-a-patch-on-a-user-by-name"},{"openapi":"get /org/{org}/user","title":"Get all users","href":"/api-reference/user/get-all-users"},{"openapi":"post /org/{org}/user/-query","title":"Get all users based on a query","href":"/api-reference/user/get-all-users-based-on-a-query"},{"openapi":"post /org/{org}/user/-invite","title":"Invite users to this org","href":"/api-reference/user/invite-users-to-this-org"},{"openapi":"get /org/{org}/user/{name}/-accessreport","title":"Get the access report for a user by name","href":"/api-reference/user/get-the-access-report-for-a-user-by-name"},{"openapi":"get /org/{org}/user/-schema/permissions","title":"Get available permissions for a user resource type","href":"/api-reference/user/get-available-permissions-for-a-user-resource-type"}]},{"group":"Volume Set","pages":[{"openapi":"get /org/{org}/gvc/{gvc}/volumeset/{name}","title":"Get a volumeset by GVC and name","href":"/api-reference/volumeset/get-a-volumeset-by-gvc-and-name"},{"openapi":"delete /org/{org}/gvc/{gvc}/volumeset/{name}","title":"Delete a volumeset by name","href":"/api-reference/volumeset/delete-a-volumeset-by-name"},{"openapi":"patch /org/{org}/gvc/{gvc}/volumeset/{name}","title":"Perform a Patch on a volumeset by name","href":"/api-reference/volumeset/perform-a-patch-on-a-volumeset-by-name"},{"openapi":"get /org/{org}/gvc/{gvc}/volumeset","title":"List volumesets in a GVC you are authorized to view","href":"/api-reference/volumeset/list-volumesets-in-a-gvc-you-are-authorized-to-view"},{"openapi":"post /org/{org}/gvc/{gvc}/volumeset","title":"Create a volumeset","href":"/api-reference/volumeset/create-a-volumeset"},{"openapi":"get /org/{org}/volumeset","title":"Get all volumesets","href":"/api-reference/volumeset/get-all-volumesets"},{"openapi":"post /org/{org}/volumeset/-query","title":"Get all volumesets based on a query","href":"/api-reference/volumeset/get-all-volumesets-based-on-a-query"},{"openapi":"get /org/{org}/gvc/{gvc}/volumeset/{name}/-accessreport","title":"Get the access report for a volumeset by GVC and name","href":"/api-reference/volumeset/get-the-access-report-for-a-volumeset-by-gvc-and-name"},{"openapi":"get /org/{org}/volumeset/-schema/permissions","title":"Get available permissions for a volumeset resource type","href":"/api-reference/volumeset/get-available-permissions-for-a-volumeset-resource-type"}]},{"group":"Workload","pages":[{"openapi":"get /org/{org}/gvc/{gvc}/workload/{name}","title":"Get a workload by GVC and name","href":"/api-reference/workload/get-a-workload-by-gvc-and-name"},{"openapi":"delete /org/{org}/gvc/{gvc}/workload/{name}","title":"Delete a workload by name","href":"/api-reference/workload/delete-a-workload-by-name"},{"openapi":"patch /org/{org}/gvc/{gvc}/workload/{name}","title":"Perform a Patch on a workload by name","href":"/api-reference/workload/perform-a-patch-on-a-workload-by-name"},{"openapi":"get /org/{org}/gvc/{gvc}/workload/{workload}/deployment/{name}","title":"Get a deployment by GVC, workload and name","href":"/api-reference/workload/get-a-deployment-by-gvc-workload-and-name"},{"openapi":"get /org/{org}/gvc/{gvc}/workload","title":"List workloads in a GVC you are authorized to view","href":"/api-reference/workload/list-workloads-in-a-gvc-you-are-authorized-to-view"},{"openapi":"post /org/{org}/gvc/{gvc}/workload","title":"Create a workload","href":"/api-reference/workload/create-a-workload"},{"openapi":"get /org/{org}/workload","title":"Get all workloads","href":"/api-reference/workload/get-all-workloads"},{"openapi":"get /org/{org}/gvc/{gvc}/workload/{workload}/deployment","title":"List deployments in a workload","href":"/api-reference/workload/list-deployments-in-a-workload"},{"openapi":"post /org/{org}/workload/-query","title":"Get all workloads based on a query","href":"/api-reference/workload/get-all-workloads-based-on-a-query"},{"openapi":"get /org/{org}/gvc/{gvc}/workload/{name}/-accessreport","title":"Get the access report for a workload by GVC and name","href":"/api-reference/workload/get-the-access-report-for-a-workload-by-gvc-and-name"},{"openapi":"get /org/{org}/workload/-schema/permissions","title":"Get available permissions for a workload resource type","href":"/api-reference/workload/get-available-permissions-for-a-workload-resource-type"}]}]},{"group":"Audit API","pages":[{"group":"Query Events","pages":[{"openapi":"get /org/{org}/id/{id}","title":"Get an audit event by ID","href":"/api-reference/audit/query/get-an-audit-event-by-id"},{"openapi":"get /org/{org}/requestId/{requestId}","title":"Get all audit events by request ID","href":"/api-reference/audit/query/get-all-audit-events-by-request-id"},{"openapi":"get /org/{org}/subject/email/{subjectEmail}","title":"Get all audit events by subject email","href":"/api-reference/audit/query/get-all-audit-events-by-subject-email"},{"openapi":"get /org/{org}/resource/id/{resourceId}","title":"Get all audit events by resource ID","href":"/api-reference/audit/query/get-all-audit-events-by-resource-id"},{"openapi":"get /org/{org}/resource/name/{resourceName}","title":"Get all audit events by resource name","href":"/api-reference/audit/query/get-all-audit-events-by-resource-name"},{"openapi":"get /org/{org}","title":"Get all audit events by query parameters","href":"/api-reference/audit/query/get-all-audit-events-by-query-parameters"}]},{"group":"Producer","pages":[{"openapi":"post /org/{org}/auditctx/{contextName}","title":"Create a new audit event","href":"/api-reference/audit/producer/create-a-new-audit-event"}]}]}]}]},"basePath":"","title":"Get an org by name - Control Plane","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}